web-dev-qa-db-ja.com

Javadocでパッケージレベルのコメントを追加する方法は？

私は CheckStyle 、 FindBugs 、および [〜＃〜] pmd [〜＃〜] Javaコード。これらのツールで検出されたほとんどすべてのバグを修正しました。

Checkstyleがキャッチしたバグである「パッケージコメント」の書き方を理解できません。 CheckStyleのドキュメントを調べましたが、理解できません。

誰かがJavaでパッケージレベルのコメントを書くのを手伝ってくれますか？

javadocumentationcommentsjavadoc
44
Anil Kumar.C

パッケージレベルのjavadocコメントは、パッケージディレクトリ内のpackage-info.Javaという名前のファイルに配置されます。コメントとパッケージ宣言が含まれています。

/**
 * Provides the classes necessary to create an applet and the classes an applet uses 
 * to communicate with its applet context. 
 * <p>
 * The applet framework involves two entities: 
 * the applet and the applet context. An applet is an embeddable window (see the 
 * {@link Java.awt.Panel} class) with a few extra methods that the applet context 
 * can use to initialize, start, and stop the applet.
 *
 * @since 1.0
 * @see Java.awt
 */
package Java.lang.applet;

これはここに文書化されています： パッケージコメントファイル

68
Michael Borgwardt
  1. ファイルを作成するpackage-info.Java文書化するパッケージ内
  2. パッケージ記述子を追加します
  3. パッケージ宣言の前にコメント（/ ** ... * /）を追加します

詳細については、次のリンクを参照してください。 http://docs.Oracle.com/javase/specs/jls/se5.0/html/packages.html

Package-info.Javaが存在する場合は、javadocおよび他の同様のドキュメント生成システムのpackage.htmlの代わりに使用することをお勧めします

パッケージ全体の注釈もpackage-info.Javaで宣言されます

グリーツ、GHad

28
GHad

パッケージ内にあるpackage.htmlページを作成する必要があります。 Javadocツールページのドキュメントコメントの書き方 で、このファイルの内容と構造について読むことができます。

6
Thomas Owens

Javadocを使用してパッケージレベルのドキュメントを追加するには、2つの方法があります。

  1. package-info.Java
    • 5.0からのみ
    • 望ましい方法
    • パッケージ宣言、パッケージ注釈、パッケージコメント、Javadocタグを含めることができます
  2. package.html
    • 任意のJavaバージョン
    • notには、パッケージ宣言やパッケージ注釈を含めることができます

詳細と例は here です。どちらを使用するか： Javadoc：package.htmlまたはpackage-info.Java

3
Aravind R. Yarram

Googleはこれを最初のヒットとして見つけました。

http://www.Oracle.com/technetwork/Java/javase/documentation/index-137868.html#packagecomments

各パッケージにpackage.htmlという名前のファイルを作成するだけです。

2
duffymo

コメントにpackage.htmlファイルを使用する。このドキュメントを参照してください： Javadocツールのドキュメントコメントの書き方 。

1
Carlos

パッケージレベルでドキュメントを追加できます。

Sunのドキュメント から：

通常、package-info.Javaにはパッケージ宣言のみが含まれ、その前にパッケージの注釈がすぐに付きます。ファイルには、技術的には1つ以上のパッケージプライベートクラスのソースコードを含めることができますが、非常に悪い形式です。

Package-info.Javaが存在する場合、javadocおよび他の同様のドキュメント生成システムのpackage.htmlの代わりに使用することをお勧めします。このファイルが存在する場合、ドキュメント生成ツールは、package-info.Javaの（おそらく注釈が付けられた）パッケージ宣言の直前にあるパッケージドキュメントコメントを検索する必要があります。このように、package-info.Javaはパッケージレベルの注釈とドキュメントの唯一のリポジトリになります。将来、他のパッケージレベルの情報を追加することが望ましくなった場合、このファイルはこの情報の便利なホームとなるはずです。

0
pavanlimo