如何在Javadoc中添加包级注释？

我正在使用和来验证我的Java代码。我已经修复了这些工具捕获的几乎所有bug

我无法理解如何编写“包注释”，这是checkstyle发现的一个bug。我已经阅读了CheckStyle的文档，但是我不理解它

---

有人能帮我用Java写一个包级别的注释吗？

你必须在包中创建一个

package.html

页面。您可以使用package.html文件作为注释，在上阅读此文件的内容和结构。请参阅此文档：

在包中创建一个文件

package info.java

，以记录

添加包描述符

在包声明之前添加注释（/***…*/）

以下链接提供了更多信息：

建议 package-info.java，如果存在， 替换的package.html javadoc和其他类似文件 文档生成系统

包范围的注释也将在Package-info.java中声明

格里茨，

---

GHad

谷歌发现这是第一次成功：

---

您只需在每个包中创建一个名为package.html的文件。

包级javadoc注释放在包目录中名为

package info.java

的文件中。它包含注释和包声明：

/**
 * Provides the classes necessary to create an applet and the classes an applet uses 
 * to communicate with its applet context. 
 * <p>
 * The applet framework involves two entities: 
 * the applet and the applet context. An applet is an embeddable window (see the 
 * {@link java.awt.Panel} class) with a few extra methods that the applet context 
 * can use to initialize, start, and stop the applet.
 *
 * @since 1.0
 * @see java.awt
 */
package java.lang.applet;

/**
*提供创建小程序所需的类以及小程序使用的类
*与小程序上下文通信。
*
*小程序框架涉及两个实体：
*小程序和小程序上下文。小程序是一个可嵌入窗口（请参见
*{@link java.awt.Panel}class），并使用一些额外的方法创建小程序上下文
*可用于初始化、启动和停止小程序。
*
*@自1.0以来
*@see java.awt
*/
包java.lang.applet；

---

这里有文档记录：

您可以在包级别添加文档

发件人：

通常package-info.java只包含一个包声明，前面紧跟着包上的注释。虽然从技术上讲，该文件可能包含一个或多个包私有类的源代码，但它的形式非常糟糕

---

对于javadoc和其他类似的文档生成系统，建议使用package-info.java（如果有）代替package.html。如果存在此文件，文档生成工具应该在package-info.java中的包声明（可能是带注释的）前面查找包文档注释。通过这种方式，package-info.java成为包级注释和文档的唯一存储库。如果将来需要添加任何其他包级别的信息，则该文件应证明是该信息的方便归宿

使用javadoc添加包级文档有两种方法：

package-info.java

• 仅从5.0开始
• 首选方式
• 可以包含包声明、包注释、包注释和Javadoc标记

package.html

• 任何Java版本
• 不能包含包声明和/或包批注

---

更多的细节和例子如下。使用哪种方法：

我以前从未听说过这种方法。您能提供一个指向描述它的文档的链接吗？@Thomas Owens形成链接：建议使用package-info.java（如果有）代替package.html for javadoc和其他类似的文档生成系统。关于为Javadoc写评论的页面（见我的答案）甚至没有提到这一点。@Thomas：让重叠的文档始终保持最新是一件很糟糕的事。确实如此。我会怀疑Sun（现在是Oracle）在维护文档方面会做得更好。特别是因为我从事Java开发已经5年多了，以前从未见过或听说过这种生成包级文档的方法。@MichaelBorgwardt，有没有办法为javadocs添加“概述”部分？（如图所示）我想这是因为根本没有提到package-info.java（这是当今首选的变体）。你把

package-info.html

放在哪里？我想它们放在包根目录中。尝试是有意义的。不知道自从我回答这个问题后三年内它是如何变化的。@Danijel，我们不能在包中有子文件夹，我们可以。。。