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

Question

我正在使用CheckStyle,FindBugs和PMD来验证我的Java代码.我已经修复了这些工具捕获的几乎所有错误.

我无法理解如何编写"包评论",这是checkstyle捕获的错误.我已经阅读了CheckStyle的文档,但我不明白.

有人可以帮助我在Java中编写包级别的注释吗？

Answer 1

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

这在此处记录:包评论文件

Answer 2

1. package-info.java在包中创建一个文件以进行记录
2. 添加包描述符
3. 在包声明之前添加注释(/**...*/)

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

建议package-info.java(如果存在)取代package.html用于javadoc和其他类似的文档生成系统

包广泛注释也将在package-info.java中声明

格雷茨,GHad

Answer 3

您必须package.html在包中创建一个页面.您可以在Javadoc工具的" 如何编写文档注释"页面上阅读有关此文件的内容和结构的信息.