[20200918]_javadoc.md

javadoc

• java 소스 코드에서 html 형식의 문서를 생성하기 위한 document generator

형식

• /** */

/**
 * 여기에 주석을 작성
 */

태그

Order of Tags

Include tags in the following order:

Tags	Description
@author	classes and interfaces only, required
@version	classes and interfaces only, required. See footnote 1
@param	methods and constructors only
@return	methods only
@exception	@throws is a synonym added in Javadoc 1.2
@see
@since
@serial or @serialField or @serialData
@deprecated	see How and When To Deprecate APIs

• Reference : How to Write Doc Comments for the Javadoc Tool

Example

/**
 * javadoc 예제를 위한 클래스
 * @author yjo
 * @version 1.0
 */
public class Practice {

    /**
     * 두 수를 더함
     * @param a 대상 숫자
     * @param b 더할 숫자
     * @return 두 수의 합
     */
    public int sum(int a, int b) { 
        return a + b; 
    }
}

생성

• 아래 명령어 이용

javadoc -d doc Practice.java

• 해당 디렉터리에 doc/Practice.html 생성됨