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（残りのソースファイルと共に）に

— 置く

48

他の回答で説明されているように、Java 1.4までは、HTMLファイルpackage.htmlを提供する必要がありました。

Java 1.5以降では、 package-info.javaでは、通常のJavadocコメント（HTMLなし）を含むます。後者は、いくつかの追加機能（特にパッケージアノテーション）を提供するため、推奨されます。

— sleske
ソース

2

+1は、両方の方法、およびそれらの間の本質的な違いについて言及するためのものです。ちなみに、少なくともIntelliJ IDEAは現在package.htmlのサポートが優れています（パッケージ名のCtrl-QでパッケージJavadocsが表示されます）。

— Jonik

3

私の以前のコメントの更新：最近のIDEAは問題package-info.javaなくサポートしています。

— Jonik 2013年

4

package.html（そのパッケージのディレクトリ内にIE）パッケージレベルでのファイル。これはHTML、<html>タグが定義された完全な形式のファイルである必要があります

— oxbow_lakes
ソース

1

詳細は？ファイルはどのように見えるべきですか？

— jjnguy 2009年

1

これは、パッケージの説明を含むHTMLファイルです。それでおしまい！

— oxbow_lakes 2009年

3

これは古いやり方です。Java 1.5以降では、

— package-info.java