Javadoc：package.html或package-info.java

当试图创build包级Javadoc评论时，最好的方法是什么？ 你是做什么？

package-info.java

• 优点
  • 较新
• 缺点
  • 滥用类 – 类是为代码，而不是只有评论

package.html的

• 优点
  • HTML扩展意味着它不是代码
  • 在IDE的/文本编辑器中的语法突出显示
• 缺点
  • 没有？

---

对于我来说，我一直使用Package.html。 但我想知道如果它是正确的select。

Answer 1

package-info.java ：“这个文件在JDK 5.0中是新的，比package.html更受欢迎。” – javadoc – Java API Documentation Generator

附录：最大的区别似乎是包注释 。 7.4包装声明的基本原理还有一点。

附录：注释function也在这里和这里提到。

附录：另请参见Java中的声明性编程：软件包级别注释 。