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 API文档生成器

附录:最大的区别似乎是包装注释.7.4包声明中的基本原理还有一些.

附录:此处和此处还提到了注释功能.

附录:另见什么package-info.java？.