Java Doc 사용법

 


Version 1.0

  


 

*    @ author 이름

-         이 태그는 모든 클래스와 인터페이스 정의에서 사용되어야 한다.

-         개별적인 메소드와 필드에서는 사용하면 안된다.

-         클래스가 여러 명의 작성자를 가지고 있다면인접 라인에 여러 개의 태그를 사용할수 있다.

 

*    @ version 텍스트

-         모든 클래스 및 인터페이스 문서 주석에 포함되어야 한다.

-         개별적인 메소드와 필드에서는 사용할 수 없다.

 

*    @ param 매개변수 – 이름 설명

-         메소드나 생성자에 사용되는 주석

-         각각의 매개변수에 대해 하나의 태그를 사용한다.

-         매개변수가 세부 설명을 요구한다면 이 설명은 다중 라인으로 싸여지고 필요한 양 만큼의 텍스트도 포함할 수 있다.

-         각각의 설명을 서로 정렬하기 위해서 공백을 사용할 수도 있다.

Ex) @param o     삽입객체

    @param index 삽입객체의 인덱스

 

*    @return 설명

-         메소드가 void를 리턴하거나 생성자가 아닌 경우를 제외하고 모두 사용해야 한다.

Ex) @return ‘<code>true</code>’  삽입이 성공한 경우

            ‘<code>false</code>’ 삽입이 실패한 경우

 

*    @exception, throws

Ex) @exception java.io.FileNotFoundException

               지정된 파일이 발견되지 않는 경우

 

*    @see 참조

-         @see java.lang.reflect

-         @see java.util.List

-         @see List

-         @see java.io.InputStream#reset

-         @see InputStream#close

-         @see InputStream#read(byte[], int, int)

-         @see #setBackgroundColor

-         @see #setPosition(int, int)

-         @see java.io.BufferedInputStream#buf

-         #see #x

 

*    @deprecated 설명

-         클래스인터페이스메소드필드가 데플리케이트 되었으며 이의 사용을 피해야 한다는 것을 알려준다.

-         클래스가 언제 데플리케이트 되었는지 지정해야 한다.

Ex) @deprecated 버전 3.0에서 이메소드는 {@link #setColor}로 대체 되었음.

 

*    @since 버전

-         클래스인터페이스메소드필드가 해당 API에 추가된 때를 지정하는 데 사용

-         이 태그 뒤에는 버전 숫자나 다른 버전 명세가 뒤따라와야 한다.

Ex) @since 3.0

 

 

 

 



+ Recent posts