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

Question

Java API では、パッケージの Javadoc コメントを確認できます。

パッケージを文書化する Javadoc コメントはどのように/どこに配置すればよいですか?

score 272 · Accepted Answer

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

score 51 · Accepted Answer

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

Java 1.5 以降package-info.java、通常の Javadoc コメント (HTML なし) を含むを提供することもできます。後者は、いくつかの追加機能 (特にパッケージ注釈) を提供するため、推奨されます。

score 3 · Accepted Answer

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

3 に答える 3