Java로 패키지를 문서화하는 방법은 무엇입니까?

151

Java API에서 패키지에 대한 Javadoc 주석을 볼 수 있습니다.Java로 패키지를 문서화하는 방법은 무엇입니까?

패키지를 문서화하는 방법과 위치는 어디에서 요?

2009-03-08 jjnguy

214

1.5으로 당신이 package-info.java 파일을 정의하고 패키지의 표준 자바 독 스타일의 주석을 제공 할 수 있습니다

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

2009-03-08 22:42:24

사양에 대한 직접 링크 : http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 intellij의 – gavenkoa

에서 패키지를 마우스 오른쪽 버튼으로 클릭하고 옵션 새 파일 메뉴 아래에 있어야합니다. – bsautner

package.html 파일을 패키지 레벨 (즉, 해당 패키지의 디렉토리)에 두십시오. 이것은 완전한 형태의 HTML 파일이어야하며 <html> 태그가 정의되어 있어야합니다.

2009-03-08 22:18:50

더 DETA ils? 파일은 어떻게 생겼을 까? – jjnguy

패키지 설명이 들어있는 HTML 파일입니다. 그게 다야! –

이것은 이전 방법입니다. Java 1.5 이후부터는 package-info.java – k2col

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

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

2009-03-08 22:42:13 sleske

+1을 사용하여 두 가지 방법 모두와 그 근본적인 차이점을 언급 할 수 있습니다. 그런데 적어도 IntelliJ IDEA는 현재 package.html (패키지 이름의 Ctrl-Q는 Javadocs 패키지를 보여줍니다)을 더 잘 지원합니다. – Jonik

나의 이전 코멘트로 업데이트 : 요즘 IDEA는'package-info.java'를 잘 지원합니다. – Jonik

답변