[解決済み] [Solved] Javadoc: package.html or package-info.java

質問

パッケージレベルのJavadocコメントを作成する場合、どのような方法が望ましいですか？何をするんですか？

package-info.java

• 長所
  • 新着情報
• 短所
  • クラスの乱用 - クラスはコードのためにあり、コメントだけのためにあるのではない

package.html

• 長所
  • HTML拡張は、コードではないことを意味します。
  • IDE/テキストエディタでのシンタックスハイライト機能
• 短所
  • なし？

私の場合、いつもPackage.htmlを使っています。しかし、その選択が正しいかどうかは疑問です。

どのように解決するのですか？

package-info.java : "このファイルはJDK5.0の新機能で、package.html."よりも優先されます。 javadoc - Java API ドキュメントジェネレータ

追記：大きな違いはあるようです。 パッケージ注釈 . には、もう少し根拠があるんです。 7.4 パッケージ宣言 .

追記：アノテーション機能についても言及されています これ と これ .

追記：こちらもご覧ください 何が package-info.java のために？ .