首页 ❯

Javadoc：package.html或package-info.java

java javadoc
2022-08-31 05:45:45

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

包信息.java

  • 优点
    • 新
  • 缺点
    • 滥用类 - 类用于代码，而不仅仅是注释

包装.html

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

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


答案 1

package-info.java：“此文件是 JDK 5.0 中的新增文件，优先于包.html。—javadoc - Java API Documentation Generator

附录：最大的区别似乎是包注释。在 7.4 包声明中还有更多基本原理。

附录：这里也提到了注释功能，在Javadoc提示中也提到了：更喜欢包信息而不是包.html，这里引用。

附录：另请参阅什么是包信息.java？。


答案 2

推荐
更多 »
标签
更多 »
php pass-by-reference optional-parameters default-value javascript arrays dom function string object serialization tostring visibility syntax jslint use-strict operators equality equality-operator identity-operator datetime timestamp date-arithmetic redirect angularjs loops foreach iteration scope variables
推荐
更多 »