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

Question

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

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

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

Answer 1

1. 在包中创建一个文件package-info.java来记录
2. 添加包描述符
3. 在包声明之前添加注释（/**…*/）

以下链接提供了更多信息：http://docs.oracle.com/javase/specs/jls/se5.0/html/packages.html

It is recommended that package-info.java, if it is present, take the place of package.html for javadoc and other similar documentation generation systems

包范围的注释也将在包信息中声明。爪哇

格里茨， 加德

Answer 2

您必须在包中创建一个package.html页面。你可以在How to Write Doc Comments for the Javadoc Tool page上阅读这个文件的内容和结构

Answer 3

通过使用包。html文件，供您评论。请参阅以下文件：How to Write Doc Comments for the Javadoc Tool

Answer 4

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

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#packagecomments

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

Answer 5

包级别的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;

这里有记录：Package Comment Files

Answer 6

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

1. 包裹信息。JAVA
   • 只从5.0开始
   • 首选方式
   • 可以包含包声明、包注释、包注释和Javadoc标记
2. 包裹。html
   • 任何Java版本
   • 不能包含包声明和/或包注释

更多细节和例子见here。使用哪一个：Javadoc: package.html or package-info.java