5

一部のAPIドキュメントには、パッケージレベルの情報が含まれています。たとえば、ここjava.ioには3つのパッケージレベルのセクションが含まれていますhttp://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html

セクションは、「パッケージjava.ioの説明」、「パッケージの仕様」、および「関連ドキュメント」です。

javadocが同じように処理できるように、これらのセクションのコンテンツを自分のプロジェクトのどこに配置する必要がありますか?

4

3 に答える 3

6

package-info.java各パッケージで呼び出されるファイルを作成します

内部は次のことを行います

/**
 * Javadoc
 */
package my.cool.package123;
于 2012-10-15T14:55:58.327 に答える
2

あなたはそれらのコメントをパッケージコメントファイルに入れます(私の強調):

各パッケージには、独自の「ソース」ファイルに含まれる独自のドキュメントコメントを含めることができます。このコメントは、Javadocツールが生成するパッケージの概要ページにマージされます。通常、このコメントには、パッケージ全体に適用されるすべてのドキュメントを含めます。

パッケージコメントファイルを作成するには、コメントを配置する2つのファイルを選択できます。

  • package-info.java-パッケージ宣言、パッケージ注釈、パッケージコメント、およびJavadocタグを含めることができます。このファイルは通常、package.htmlよりも優先されます。
  • package.html-パッケージコメントとJavadocタグのみを含めることができ、パッケージ注釈は含めることができません。
于 2012-10-15T14:56:45.830 に答える
1

package-info.javaパッケージを含むフォルダに呼び出されたファイルを配置する必要があります。

于 2012-10-15T14:56:34.007 に答える