CheckStyle配置
Checkstyle使用
Checkstyle是检查java程序代码样式的工具。ide中可以通过checkstyle插件检查代码。
Checkstyle配置是通过指定modules来应用到java文件的。modules是树状结构，以一个名为Checker的module作为root节点，一般的checker都会包括TreeWalker子module。
在xml配置文件中通过module的name属性来区分module，module的Properties可以控制如何去执行这个module，每个property都有一个默认值，所有的check都有一个severity属性，用它来指定check的level。TreeWalker为每个java文件创建一个语法树，在节点之间调用submodules的Checks。
checkstyle具体用法
Javadoc Comment 文档规范
AtclauseOrder
检查javadoc块标签或javadoc标签的顺序
violateExecutionOnNonTightHtml
target
tagOrder
JavadocMethod
检查方法或构造函数的Javadoc。
name|描述
---|---
minLineCount|
allowedAnnotations|
validateThrows|
scope|
excludeScope|
allowUndeclaredRTE|
allowThrowsTagsForSubclasses|
allowMissingParamTags|
allowMissingThrowsTags|
allowMissingReturnTag|
allowMissingJavadoc|
allowMissingPropertyJavadoc|
logLoadErrors|
suppressLoadErrors|
ignoreMethodNamesRegex|
tokens|
JavadocPackage
检查每个java包是否有说明文档。默认情况下，只允许package-info.java,但可以配置为允许package.html文件。如果两个文件都存在会报告错误。allowLegacy 是否允许package.html文件
fileExtensions 文件类型扩展名设置
JavadocParagraph