Javadoc:package.html 或 package-info.java [英] Javadoc: package.html or package-info.java

问题描述

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

When trying to create package level Javadoc comments, whats the preferred method? What do you do?

package-info.java

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

  package.html

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

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

    For me, I've always used Package.html. But I'm wondering if its the correct choice.

    推荐答案

    package-info.java: 这个文件是 JDK 5.0 中的新文件，优先于 package.html."—javadoc - Java API 文档生成器

    package-info.java: "This file is new in JDK 5.0, and is preferred over package.html."—javadoc - The Java API Documentation Generator

    附录:最大的区别似乎是包注释.在 7.4 包声明.

    Addendum: The big difference seems to be package annotations. There's a little more in the way of rationale in 7.4 Package Declarations.

    附录:此处和此处.

    附录:另见什么是package-info.java for?.

    Addendum: See also What’s package-info.java for?.

    这篇关于Javadoc:package.html 或 package-info.java的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！