web-dev-qa-db-ja.com

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

Java APIで、パッケージのJavadocコメントを見ることができます。

パッケージを文書化するためのJavadocコメントの配置方法

javapackagesjavadoc
175
jjnguy

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

パッケージの言語仕様

246
Gareth Davis

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

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

詳細： javadocのSunのドキュメント

45
sleske

とともに package.htmlファイルをパッケージレベルで（つまり、そのパッケージのディレクトリに）。これは完全な形式のHTMLファイルで、<html>タグで定義されています

4
oxbow_lakes