尝试创建包级Javadoc注释时,首选方法是什么?你是做什么?
包信息.java
- 优点
- 较新的
- 缺点
- 滥用类-类仅用于代码,而不仅仅是注释
package.html
- 优点
- HTML扩展名表示其不是代码
- IDE /文本编辑器中的语法突出显示
- 缺点
- 没有?
对于我来说,我一直使用Package.html。但是我想知道它是否是正确的选择。
我不会将package-info.java视为滥用类。它是一个Java源文件(文件扩展名为“ .java”),但不是类文件,因为它不包含类声明。而且,实际上,它不能包含类声明,因为“ package-info”不是合法的类名。
—
Scrubbie 2011年
使用package-info.java而不是package.html的另一个原因可能是.java并不暗示文档的特定输出格式。例如,您可能想将javadoc输出为LaTeX或PDF文件。取决于javadoc编译器的实现,这可能会在.html情况下引起问题。
—
honeyp0t 2012年
实际上@Scrubbie-尽管您应该是对的,但我认为您可以在其中指定package-private类。:-(我同意你的看法,虽然,使用
—
mjaggard
package-info.java
的Javadoc和注解是不是一类的滥用。
@JonasN参见stackoverflow.com/a/14708381/751579(我知道您3年前就遇到了这个问题,但是现在也许有人需要这个小费)
—
davidbak
package-info.java
可以包含[package]注释-不一定是所有API文档。