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

java documentation comments javadoc

2022-08-31 22:20:08

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

我无法理解如何编写“包注释”，这是一个由checkstyle捕获的错误。我已经浏览了CheckStyle的文档，但我不明白。

有人可以帮助我用Java编写包级注释吗？

答案 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;

这记录在这里：包注释文件

答案 2

在包中创建要记录的文件package-info.java
添加包描述符
在包声明之前添加注释（/** ...*/）

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

对于javadoc和其他类似的文档生成系统，建议使用package-info.java（如果存在）代替pack.html

包范围的注释也将在包信息中声明.java

Greetz， GHad