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

182

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

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

java packages javadoc

— jjnguy
소스

257

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

— 가레스 데이비스
소스

3

사양으로 직접 연결 : docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1

— gavenkoa

7

intellij에서 패키지를 마우스 오른쪽 버튼으로 클릭하면이를 만드는 옵션이 새 파일 메뉴 아래에 있어야합니다

— bsautner

파일이 packagename / src / packagename에 있어야한다는 것을 알았습니다 (나머지 소스 파일 포함)

— trindflo

48

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

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

— 썰매
소스

2

두 가지 방법과 그 둘 사이의 본질적인 차이점을 언급 한 +1 그건 그렇고, 적어도 IntelliJ IDEA는 현재 package.html을 더 잘 지원합니다 (패키지 이름의 Ctrl-Q는 Javadocs 패키지를 보여줍니다).

— Jonik

3

내 이전 의견으로 업데이트 : 요즘 IDEA는 package-info.java잘 지원 합니다.

— Jonik

4

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

— oxbow_lakes
소스

1

자세한 내용은? 파일은 어떻게 생겼습니까?

— jjnguy 2016 년

1

패키지 설명이 포함 된 HTML 파일입니다. 그게 다야!

— oxbow_lakes

3

이것이 오래된 방법입니다. Java 1.5부터 package-info.java를 사용할 수 있습니다

— k2col