自定义checkstyle.doc

定制检查：Checkstyle没有图形化的定制器，所以需要手工修改配置文件。比如，我们的代码需要符合下列规则： * 长度方面：文件长度不超过1500行，每行不超过120个字，方法不超过60行. * 命名方面：类名不能小写开头，方法名不能大写开头，常量不能有小写字母。 * 编码方面：不能用魔法数(Magic Number），if最多嵌套3层。 那么，我们的检查配置文件（如命名成 my_check.xml ） 应该是这样的：  下面是对具体的check的描述。这些check可以被分为了15类，如下所示： ===== CHECK STYLE ======== ----- Annotations -------- JDK5中的Annotation相关（未展开） ----- Block Checks ------- 代码块相关 ----- Class Design ------- 类设计相关 ----- Coding ------------- 编码相关 ----- Duplicate Code ----- 冗余代码 ----- Headers ------------ 源文件的头 ----- Imports ------------ 引入包相关 ----- Javadoc Comments --- JavaDoc相关 ----- Metrics ------------ 复杂度分析 ----- Miscellaneous ------ 其它 ----- Modifiers ---------- 修饰符相关 ----- Naming Conventions - 命名规范 ----- Regexp ------------- 正则表达式相关 ----- Size Violations ---- 文件大小等相关 ----- Whitespace --------- 空格处理相关 ========================== ?xml version=1.0 encoding=UTF-8? !DOCTYPE module PUBLIC -//Puppy Crawl//DTD Check Configuration 1.2//EN /dtds/configuration_1_2.dtd module name=Checker module name=TreeWalker !-- 长度方面的检查 -- !-- 文件长度不超过1500行 -- module name=FileLength property name=max value=1500/ /module !-- 每行不超过120个字-- module name=LineLength property name=max value=120/ /module !-- 方法不超过60行 -- module name=MethodLength property name=tokens value=METHOD_DEF/ property name=max value=60/ /module !-- 命名方面的检查，它们都使用了Checkstyle默认的规则。 -- !-- 类名(class 或interface) 的检查 -- module name=TypeName/ !-- 方法名的检查 -- module name=MethodName/ !-- 常量名的检查 -- module name=ConstantName/ !-- 编码方面的检查 -- !-- 不能用魔法数 -- module name=MagicNumber/ !-- if最多嵌套3层 -- module name=NestedIfDepth property name=max value=3/ /module /module /module 可以看出，想增加一个检查，就是增加一个module/结点。具体的结点内容在后面的文档都会写明。dds 1. !DOCTYPE module PUBLIC 2. -//Puppy Crawl//DTD Check Configuration 1.2//EN 3. /dtds/configuration_1_2.dtd 4. module name=Checker 5. 6. !-- 7. 重复代码的检查，超过8行就认为重复，UTF-8格式 本检查一定要放在TreeWalker节点前，否则在 8. Checkclipse中会无法使用。(在ant下