Javadoc：package.htmlまたはpackage-info.java

Question

パッケージレベルのJavadocコメントを作成しようとすると、推奨される方法は何ですか？職業はなんですか？

package-info.Java

• 長所
  • より新しい
• 短所
  • クラスの乱用-クラスはコメント用ではなくコード用です

package.html

• 長所
  • HTML拡張は、コードではないことを意味します
  • IDE /テキストエディターでの構文の強調表示
• 短所
  • 無し？

---

私にとっては、常にPackage.htmlを使用しています。しかし、私はそれが正しい選択かどうか疑問に思っています。

Answer 1

package-info.Java： "このファイルはJDK 5.0で新しく追加され、package.htmlよりも優先されます。" — javadoc-Java AP​​Iドキュメントジェネレーター

補遺：大きな違いはパッケージアノテーションのようです。 7.4 Package Declarations には、もう少し理由があります。

補遺：注釈機能についても here および here に言及しています。

補遺： What's package-info.Java for？ もご覧ください。