[JAVA] javadoc 사용법

JAVA 이야기

javadoc 사용법

javadoc는 자바 소스 파일에서 주석 부분을 HTML페이지로 작성해 주는 도구이다.

 

JDK 에서 제공되며 /** */ 안의 주석 내용을 HTML로 바꾸어 주는 역할을 한다.

 

/**
     8      * Sorts a Vector of objects.
     9      *
    10      * @param vec the vector
    11      * @param dir true for ascending order, false for descending
    12      * @exception SortArgumentException if vec is null
    13     

*/

 

위와 같은 형태로 작성한다.

 

/** */ 주석 안에서는 @ 태그을 사용하는 것이 가능하다

 

@ 태그 사용법은 다음과 같다.

 

@see  class_name                      : "See also"라는 항목을 만들어 해당 클래스와 연결해준다.
@see  class_name#method_name : "See also"라는 항목을 만들어 특정 메소드와 연결해준다.
@version  text                             : HTML 파일의 버전을 표시하는 항목을 만들어 준다.
@author  text                               : HTML 파일의 저자를 표시하는 항목을 만들어 준다.
@param  name  description           : 특정 메소드가 취하는 파라메터를 기술할 때 사용된다.
@return  description                     : 특정 메소드의 리턴값을 기술할 때 사용된다.
@exception  class_name              : 특정 메소드가 발생시킬 수 있는 예외상황을 기술할 때 사용된다.