JavaDoc 주석 만들기

JavaDoc

@author : 클래스나 인터페이스의 제작자 표시 

@version : 버전정보 

@return : 메소드가 void형이 아닌경우 return value type을 기술 

@exception : 메소드가 발생 시킬수 있는 예외를 기술 

@throws : @exception Tag와 동일 

@deprecated : 다음버젼에서 폐기된 메소드를 알림 

@param : 매개변수에 대한 설명(@param 변수 설명의 형태) 

@serial : 기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명 

@see : 어떤 클래스 , 인터페이스,메소드, 생성자 혹은 URL에 대한 전후참조표시 

    @see 클래스이름, @see 클래스의 완전한이름,@see 클래스완전하이름#메소드 

@since : Tag를 가진 객체가 언제 추가 되었는지 명시 

{@link #entity label} : 메소드나 필드의 상호 참조에 대한 링크를 표시 

                   @see와 다른 점은 link를 쓸경우 문서텍스트안에 링크가 생기는데 

                     반해 @see는 분리된 줄에 링크를 만든다. 

{@doc-root} : 문서에 대해 루트디렉토리에 대한 상대경로 지정 

Tag 이름은 대소문자를 구분한다. 

클래스와 인터페이스의 주석에는 다음의 Tag가 포함 가능하다. 

  @author,@version,@since,@deprecated,@see 

메소드와 관련된 주석에는 다음의 Tag가 포함 가능하다. 

  @throws,@exception,@param,@return,@serialData 

  - @serialData의 경우 기본적으로 직렬화 되지 않지만 

      witeObject(),readObject(),writeExternal(),readExternal() 

      등으로 읽거나 쓸수있는 항목을 설명