Javadoc:package.html或package-info.java

当尝试创建包级Javadoc注释时，首选的方法是什么？你是做什么的

package info.java

• 专业人士
  • 更新的
• 缺点
  • 滥用类-类是用于代码，而不仅仅用于注释

package.html

• 专业人士
  • HTML扩展意味着它不是代码
  • IDE/文本编辑器中的语法高亮显示
• 缺点
  • 没有

---

---

对我来说，我一直使用Package.html。但我想知道这是否是正确的选择

package info.java

：“此文件是JDK 5.0中的新文件，优于package.html。”-

附录：最大的区别似乎是包注释。这里面还有一点道理

附录：还提到了注释功能，并对其进行了说明

---

附录：另请参见。

package-info.java

可以包含[package]注释-它不一定是所有API文档。我不会将package-info.java定义为滥用类。它是java源文件（具有“.java”文件扩展名），但不是类文件，因为它不包含类声明。事实上，它不能包含类声明，因为“package info”不是合法的类名。使用package-info.java而不是package.html的另一个原因可能是。java并不意味着文档的特定输出格式。例如，您可能希望将javadoc输出为LaTeX或PDF文件。根据javadoc编译器实现的不同，这可能会在.html情况下导致问题。实际上@scrubie-虽然您应该是对的，但我认为您可以在其中指定包私有类：-（不过我同意你的看法，在Javadoc和注释中使用

package info.java

并不是滥用类。@JonasN see（我知道你3年前就有这个问题，但现在可能有人需要这个提示）有什么特别的原因使它更受欢迎吗？@TheLQ：我猜是包注释，因为编译器有更多的信息要处理；以上更多。包注释对我来说是新的，并且似乎是package-info.java的一个很好的理由，因为它的范围。编辑答案再多一点：解释“package annotation”--应用于包中所有类或整个包的注释。tech.puredanger.com链接是唯一真正解释我为什么应该关心的链接。也就是说，它是一个很好的、有用的链接。使用package-info.java，您可以使用{@link}当你链接一个java.lang类时，当生成javadoc时，你会自动得到指向该类的在线javadoc的{@link}，该类与你正在使用的jdk相匹配；当你进行重构时，ide还可以帮助你发现错误的链接。