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 - The Java API Documentation Generator

附录：最大的区别似乎是包注释。 7.4 Package Declarations中的理论基础还有一点。

附录：还提到了注释功能here和here。

附录：另见What’s package-info.java for?。