JavaDoc 만드는법

import java.util.Date;

/**
 * javaDoc Demo class
 * @autor Dante
 * @version 1.8
 *
 */
public class javaDocDemo {
    /**
     * Java Application
     * @param args String array
     * @return No return value
     */
    public static void main(String[] args) {
        System.out.print("Hello Today is :");
        System.out.println(new Date());

    }
}

기본적인 태그들

태그	설명
@param	매개 변수에 대한 설명을 표시할 때 사용한다.
@see	관련 항목으로 외부 링크 또는 텍스트 표시하거나, 다른 필드나 메소드에 대한 모든 참조 링크를 나타내는 경우 사용한다.
@author	작성자를 표시할 때 사용한다. 클래스, 인터페이스 등에 작성한다.
@version	소프트웨어의 버젼을 표시할 때 사용한다. 클래스, 인터페이스 등에 작성한다.
@deprecated	클래스나 메소드 등을 더 이상 사용을 권장하지 않을 경우에 사용한다. 사용 권장을 안하는 것 뿐이지 사용이 불가능하다는 것은 아니다.
@since	어떤 버전에서 도입이 되었는지 나타내는 태그이다.
@return	반환 값에 대한 설명(데이터 유형 및 범위 등)을 표시할 때 사용한다.

우선 자바 파일을 컴파일한다.

javac javaDocDemo.java

java 컴파일하고 터미널에서 아래와 같이 입력한다.

javadoc -author -version -d ./docs javaDocDemo.java

Untitled

Untitled 1

명령문에 의미

javadoc은 javadoc을 생성하는 명령어
-authod, -version은 저자를 표기 그리고 버젼을 표기 한다.
-d 는 문서 생성 위치 옵션이다.
위와 같은 명령어를 치면 아래의 그림같이 Docs 파일이 생긴다.

Untitled 2

doc에 들어가 index.html 파일을 연다.

Untitled 3

열게되면 javadoc을 만든 것을 알 수 있다.

Untitled 4

참고

http://www.ministory.net/xe/?mid=it_story&category=2963&page=4&document_srl=5790