Javadoc：package.html 或 package-info.java

小编典典

Javadoc：package.html 或 package-info.java

all

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

包信息.java

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

包.html

优点
- HTML 扩展意味着它不是代码
- IDE/文本编辑器中的语法高亮
缺点
- 没有任何？

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

阅读 220

收藏

2022-06-02

共1个答案

小编典典

package-info.java：“此文件是 JDK 5.0 中的新文件，优先于 package.html。” —— javadoc - Java
API
文档生成器

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

附录：这里和这里也提到了注释功能。

附录：另见 What’spackage-info.javafor？.

2022-06-02