说明

checkstyle可以检查javadoc注释是否符合规范。

Javadoc注释以/**开头，以 */结尾，可以被javadoc等工具提取，形式如：

/**
 * 保存了一些常数.
 * @author thb
 *
 */

Javadoc注释的首行以句号（.）、问号（?）、或者感叹号（!）结尾

例如：
/**
* 处理函数.
*/

/**
 * 处理函数?
 */

/**
 * 处理函数!
 */

Java包下面要有一个package-info.java文件

例如，一个java包下没有package-info.java文件，checkstyle报违反项：

为了消除这个违反项，在该包下面增加一个package-info.java文件，例如内容：

类、类属性、类方法的注释使用javadoc注释，而不使用单行注释//这样的形式

使用javadoc注释有几个好处：

• 在IDE编程环境中会给出明确提示。
• 可以用javadoc工具生成文档。
• 对调用方方便，因为调用方不用进入代码就能看到提示信息。

例如：

如果子类中覆盖了父类的方法、或者实现了接口的方法，为了避免重复写文档注释，可以使用{@inheritDoc}标记，这样既消除了checkstyle检查的违反项，又不需要重复写。例如：