JavaDoc 사용

JavaDoc 작성법

개요의 다큐멘테이션 태그

개요 태그는, 개요 페이지의 다큐멘테이션 코멘트로 사용할 수 있는 태그입니다. 이 다큐멘테이션 코멘트는, 통상 overview.html (이)라는 이름의 원시 파일내에 있습니다. 다른 다큐멘테이션 코멘트의 경우와 같게, 이러한 태그는,주설명의 나중에 사용할 필요가 있습니다.

주 - 버젼 1.2 에서는, 개요 문서내의 {@link} 태그에 버그가 있습니다. 텍스트는 올바르게 표시됩니다만, 링크가 설정되지 않습니다. 현재로서는,{@docRoot} 태그는, 개요 문서내에서는 동작하지 않습니다.

개요 태그
@see @since @author @version {@link} {@linkplain} {@docRoot}

패키지 다큐멘테이션 태그

패키지 태그는, 패키지의 다큐멘테이션 코멘트로 사용할 수 있는 태그입니다. 이 다큐멘테이션 코멘트는,package.html (이)라는 이름의 원시 파일내에 있습니다. 여기서 사용할 수 있는 @serial 태그는,include 또는 exclude 인수를 지정한 것 뿐입니다.

패키지 태그
@see @since @serial @author @version {@link} {@linkplain} {@docRoot}

클래스 및 인터페이스 다큐멘테이션 태그

이하에, 클래스 또는 인터페이스의 다큐멘테이션 코멘트로 사용할 수 있는 태그를 나타냅니다. 여기서 사용할 수 있는 @serial 태그는,include 또는 exclude 인수를 지정한 것 뿐입니다.

클래스 및 인터페이스 태그
@see @since @deprecated @serial @author @version {@link} {@linkplain} {@docRoot}

다음에 클래스 코멘트의 예를 나타냅니다.

/**
 * A class representing a window on the screen. 
 * For example:
 * <pre>
 *    Window win = new Window(parent);
 *    win.show();
 * </pre>
 *
 * @author  Sami Shaio
 * @version %I%, %G%
 * @see     java.awt.BaseWindow
 * @see     java.awt.Button
 */
class Window extends BaseWindow {
   ...
}

 

필드 다큐멘테이션 태그

이하에, 필드의 다큐멘테이션 코멘트로 사용할 수 있는 태그를 나타냅니다.

필드 태그
@see @since @deprecated @serial @serialField {@link} {@linkplain} {@docRoot} {@value}

다음에 필드 코멘트의 예를 나타냅니다.

    /**
     * The X-coordinate of the component. 
     *
     * @see #getLocation()
     */
    int x = 1263732;

 

constructor　 　 및 메소드 다큐멘테이션 태그

다음에, constructor　 　 또는 메소드의 다큐멘테이션 코멘트내에서 사용할 수 있는 태그를 나타냅니다. 다만,@return (은)는 constructor　 　 내에서는 사용하지 못하고,{@inheritDoc} 에는어느 제약이 있습니다. @serialData 태그는,특정의 직렬화 된 메소드의 다큐멘테이션 코멘트에서만 사용할 수 있습니다.

메소드 및 constructor　 　 태그
@see @since @deprecated @param @return @throws (@exception) @serialData {@link} {@linkplain} {@inheritDoc} {@docRoot}

다음에 메소드의 다큐멘테이션 코멘트의 예를 나타냅니다.

    /**
     * Returns the character at the specified index.  An index 
     * ranges from <code>0</code> to <code>length() - 1</code>. 
     *
     * @param     index  the index of the desired character. 
     * @return    the desired character. 
     * @exception StringIndexOutOfRangeException 
     *              if the index is not in the range <code>0</code> 
     *              to <code>length() -1</code>. 
     * @see       java.lang.Character#charValue()
     */
    public char charAt(int index) {
       ...
    }

========================================================