Skip to content

Javadoc

Javadoc is a documentation generator from Oracle Corporation for generating API documentation in HTML format from Java source code. The HTML format is used to add the convenience of being able to hyperlink related documents together.

javadoc 문서화를 위하여 주석은 /**로 시작하며 */로 끝나야 한다.

Javadoc 만들기 & 한글출력

커맨드라인 옵션은 아래와 같다. 

-locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8

package-info

각 패키지별로 package-info.java파일을 생성하여 패키지에 대한 정보를 입력해야 한다. 파일 내용은 아래와 같이 작성하면 된다. 

/**
 * test package info file.
 * @author username
 */
package android.test;

Tags

  • @author: 제작자 이름.
  • @version: 버전정보.
  • @return: 반환값에 대한 정보.
  • @exception: 발생할 수 있는 예외를 기술한다.
  • @throws: @exception과 동일하다.
  • @deprecated: 권장되지 않는 메서드임을 지정한다 (폐기가 예약됨).
  • @param: 매개변수에 대한 설명.
  • @serial: 직렬화 가능한 클래스 멤버를 설명.
  • @see: 클래스, 메서드, 필드, URL 등에 대한 전후참조 (링크를 제공한다).
  • @since: 업데이트 시점을 알린다 (버전, 날짜 등을 기술할 수 있다).

Tips

  • 모든 파일의 마지막 라인은 빈줄로 끝나야 한다.
  • 모든 문장의 마지막 문자는 마침표(.)로 끝나야 한다.

See also

Favorite site