如何在Javadoc中添加包级别评论？
我正在使用Check-Style，FindBugs和PMD来validation我的Java代码。 我修复了几乎所有被这些工具捕获的错误。
我无法理解如何编写“包评论”，这是checkstyle捕获的错误。 我已经通过了Check-Style的文档，但我不明白。
有人可以帮我在Java中编写一个包级别的评论吗？
包级javadoc注释放在package目录内名为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;
这是在这里logging： 包评论文件
- 在你的包中创build一个文件
package-info.java来生成文件 - 添加包描述符
- 在包声明之前添加注释（/ ** … * /）
以下链接提供了更多信息： http : //docs.oracle.com/javase/specs/jls/se5.0/html/packages.html
build议package-info.java（如果存在）代替javadoc和其他类似文档生成系统的package.html
包宽注释也将在package-info.java声明
Greetz，GHad
您必须在软件包中创build一个package.html页面。 您可以阅读关于如何为Javadoc工具撰写文档注释的文件的内容和结构。
使用javadoc添加包级文档有两种方法：
- package-info.java
- 只有5.0
- 首选方式
- 可以包含包声明，包注释，包注释和Javadoc标签
- package.html的
- 任何Java版本
- 不能包含包声明和/或包注释
更多细节和例子在这里 。 使用哪一个： Javadoc：package.html或package-info.java
谷歌发现这是第一击：
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#packagecomments
您只需在每个包中创build一个名为package.html的文件。
通过使用package.html文件的意见。 请参阅此文档： 如何为Javadoc工具编写文档注释 。
您可以在包级别添加文档。
从Sun文档 ：
通常情况下，package-info.java只包含一个包声明，其前面是包的注释。 虽然这个文件在技术上可以包含一个或多个包私有类的源代码，但这将是非常糟糕的forms。
build议package-info.java（如果存在的话）取代javadoc和其他类似文档生成系统的package.html。 如果这个文件存在，那么文档生成工具应该在package-info.java中的（可能注释的）包声明之前寻找包文档注释。 通过这种方式，package-info.java成为软件包级别注释和文档的唯一存储库。 如果将来需要添加任何其他的包级信息，则该文件应该被certificate为这个信息的便利之处。
