javadoc 관련

프로젝트 내에 수많은 자바 파일이 존재하고 개발자마다 성향은 다르지만 각기각색으로 주석을 코드에 남기곤 한다.

그러면서 인수인계 등을 위해 문서화를 해야할 일이 생길때도 있는데 지금까지 만든 파일들에 대해서 하나하나 찾아주면서 문서를 다시 작성을 해야한다.

 

이 작업을 편하게 만들어주는것이 javadoc이다.

자바 문서를 자동으로 읽어서 html 형식으로 설명, 하이퍼링크 등을 생성해준다.

 

자바독이라고 읽으며 형식을 맞춰서 생성 해야한다.

 

이클립스 상단 메뉴에서 Source > Generate Element Comment 를 선택한다.

그러면 파일 상단에 

/** * @author Administrator * */

이런 주석이 생긴다.

 

물론 커서 위치에 따라 생기는 주석은 다를수 있고 이런 주석 형식을 자바독에서 읽어서 문서화를 해준다.

주석 안이지만 @골뱅이 annotation을 통해 다양한 값을 지정할수 있는데 값들은 다음과 같다.

 

@author : 코드 소스 작성자

@deprecated : 해당 클레스(구현체)의 삭제 또는 지원이 중단되는 것을 알려줌

@exception : 예외처리할 수 있는 것들을 정의, 알파벳 순

@param : 매개변수 메서드, 생성자 설명

@return : 리턴값 설명

@see : 파일이 참조하는 다른 클래스와 메서드 등

@serial : Serializeable 인터페이스에 사용

@serialData : writeObject writeExternal 메소드로 작성된 데이터 설명

@serialField : serialPersistnetFields 모든 배열에 사용됨

@since : 해당 클래스가 추가된 버전

@throws : @exception처럼 예외처리하는 것들을 정의

@version : 구현체, 패키지 버전 명시

 

이렇게 까지 하고 나면 html 파일이 생길 것이고 index.html 을 열면 된다.

아래와 같은 화면이 나온다.