[java] Java로 패키지를 어떻게 문서화합니까?

JAVA / 글쓴이

Java API에서 패키지에 대한 Javadoc 주석을 볼 수 있습니다.

패키지를 문서화하기 위해 Javadoc 주석을 어떻게 / 어디에 배치합니까?

답변

1.5부터 package-info.java파일을 정의 하고 패키지에 대한 표준 javadoc 스타일 주석을 제공 할 수 있습니다 .

com / foo / package-info.java :

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

패키지 언어 사양

답변

Java 1.4까지는 다른 답변에서 설명한대로 HTML 파일 package.html을 제공해야했습니다.

Java 1.5부터 package-info.java일반 Javadoc 주석 (HTML 없음)이 포함 된을 제공 할 수도 있습니다 . 후자는 몇 가지 추가 기능 (특히 패키지 주석)을 제공하므로 선호됩니다.

세부 사항 :
javadoc에 대한 Sun의 문서

답변

A를 package.html(해당 패키지 디렉토리에 예) 패키지 수준에서 파일입니다. 태그가 정의 된 완전한 형식의 HTML파일 이어야합니다.<html>

답변