checkstyle 4.3 中文手册

《checkstyle 4.3 中文手册》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Checkstyle4.3中文手册加入OpenDoc前的预览版。。。申申申思维1.0版权©2008申思维本文根据Checkstyle4.3英文官方文档而来。我打算发布成OpenDoc,欢迎大家给我来信，多提意见！谢谢目录1.前言1.介绍1.1.概述1.2.特点1.3.下载2.N分钟入门3.常用的检查3.1.典型的配置文件4.用的最多的20%功能5.在Ant中使用Checkstyle5.1.N分钟极速入门5.2.安装与配置5.3.典型例子5.4.checkstyle任务的参数5.5.可以嵌套的ant元素6.在Eclipse中使用Checkstyle6.1.下载和安装6.2.配置

2、方法6.3.使用6.4.常见问题7.各种检查7.1.如何配置检查7.2.JavaDoc注释7.2.1.类和接口的javadoc7.2.2.方法的javadoc7.2.3.方法的javadoc7.2.4.变量的javadoc7.3.命名约定7.3.1.模块一览7.3.2.注意7.4.文件头7.5.Imports7.5.1.import中避免星号"*"7.5.2.没用的import7.6.长度限制7.6.1.文件长度7.6.2.每行长度第1页共54页2008-3-1018:467.6.3.方法长度7.6.4.方法的参数个数7.7.空格7.7.1.方法名与左边圆括号之间7.7.2.

3、圆括号附近的空格7.7.3.类型转换中圆括号附近的空格7.7.4.对"Tab"的检查7.7.5.特定符号后的空格7.8.关键字7.8.1.关键字的出现顺序7.8.2.多余的关键字7.9.对区域(emptyblock)的检查7.9.1.空白区域7.9.2.对左侧括号{的检查（略）7.9.3.需要括号的区域7.9.4.对右侧括号}的检查（略）7.9.5.不必要的括号7.10.编码的检查7.10.1.数组尾巴的逗号7.10.2.避免内联(inline)条件判断7.10.3.override的equals方法7.10.4.空语句(statement)7.10.5.equals和has

4、hCode方法7.10.6.应该声明成final的局部变量7.10.7.不合适的初始化7.10.8.不合适的token7.10.9.内部赋值语句7.10.10.魔法数7.10.11.丢了default分支的switch7.10.12.被更改的循环控制变量7.10.13.多余的throw7.10.14.未被简化的条件表达式7.10.15.未被简化的布尔返回值7.10.16.字符串(String)的比较7.10.17.嵌套的if层次7.10.18.嵌套的try层次7.10.19.调用父类的clone7.10.20.父类的finalize7.10.21.不合理的catch7.10.

5、22.不合理的throws7.10.23.package声明7.10.24.JUnitTestCase7.10.25.return语句的数量7.10.26.声明的顺序7.10.27.参数被赋值7.10.28.详尽的变量初始化7.10.29.switch语句的default位置排在最后7.10.30.丢失的构造函数7.10.31.switch中错误分支。7.10.32.多个内容相同的字符串变量7.10.33.同一行禁止声明多个变量7.10.34.不使用this7.10.35.不必要的圆括号7.11.Class的设计7.11.1.可见的修改方法第2页共54页2008-3-1018

6、:467.11.2.Finalclass7.11.3.InterfacelsType7.11.4.隐藏工具类的构造方法7.11.5.方便继承(extention)而进行的设计7.11.6.throws的数量7.12.重复的代码7.12.1.StrictDuplicateCode严格的重复代码检查7.13.各种量度7.13.1.布尔表达式的复杂度7.13.2.类数据的抽象耦合7.13.3.类的分散复杂度7.13.4.函数的分支复杂度7.13.5.Npath复杂度7.14.杂项7.14.1.禁止使用的表达式7.14.2.文件结尾的回车7.14.3.Todo注释7.14.4.翻译属

7、性文件7.14.5.没有被注释掉的Main函数7.14.6.大写的L7.14.7.声明数组的风格7.14.8.final型的参数7.14.9.缩进7.14.10.与代码同行的注释7.14.11.必须出现的字符串术语表参考书目插图清单2.1.测试如何使用checkstyle的项目2.2.开启Checkstyle2.3.代码窗口中的错误提示2.4.Problems窗口中的错误提示2.5.增加了class的注释后的效果图2.6.使用自定义的Checkstyle配置文件2.7.定制配置的检查结果2.8.修正后的