Javaでパッケージを文書化するにはどうすればよいですか？

151

Java APIでは、パッケージのJavadocコメントを見ることができます。Javaでパッケージを文書化するにはどうすればよいですか？

パッケージを文書化するにはどのようにJavadocのコメントを配置しますか？

2009-03-08 jjnguy

214

あなたが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

2009-03-08 22:42:24

specellへの直接リンク：http：//docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 intelijの – 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

答えて