开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

社区首页 >问答首页 >Javadoc: package.html或package-info.java

问Javadoc: package.html或package-info.java
EN

Stack Overflow用户

提问于 2010-09-05 02:02:03

回答 1查看 93K关注 0票数 234

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

package-info.java

专业
- 更新版本

Cons
- 滥用类类是为了代码，而不仅仅是为了注释。

package.html

专业
- HTML扩展意味着它的非代码
- IDE/文本编辑器中的语法突出显示

Cons
- 一个都没有？

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

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2010-09-05 02:09:16

package-info.java：“这个文件在JDK5.0中是新的，比package.html更好。”-https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#packagecomment。

增编:最大的区别似乎是包注释。在https://docs.oracle.com/javase/specs/jls/se8/html/jls-7.html#jls-7.4中有更多的基本原理。

增编:注释特性也提到了这里，在https://web.archive.org/web/20080204050234/http://blogs.sun.com/darcy/entry/javadoc_tip_prefer_package_info中，引用了这里。

增编:另见。

票数 274

EN

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/3644726

复制

相似问题