《Checkstyle中文手册》pdf电子书免费下载
下载方式一：
百度网盘下载地址：https://pan.baidu.com/s/1y-SbXZjlg3WIlCYlN2JcNQ
百度网盘密码：1111
下载方式二：
http://ziliaoshare.cn/Download/af_123663_pd_CheckstyleZWSC.zip
|
|
作者：empty 出版社：empty |
《Checkstyle中文手册》介绍
Checkstyle是非常优秀的代码规范检查软件， 可以大幅的提高代码质量， 当项目的开发人员比较多时，用它来统一代码风格是很有必要的。本文的写作，是由于公司的质量管理部门对代码格式进行了要求。在网上也没有发现有比较详细全面的中文文档。所以参考Checkstyle 4.3的官方文档写就。有个比较神奇的20%-80%规律是这样说的：一本书，用的最多的只是20%的内容，它的出现几率是80%：而剩下的80%内容，被使用的不到20%。这个规律也同样适用在其他东东上。只是数据上稍有差异。所以我特意安排了第4章用的最的20%功能，作为典型的使用方法。对于赶时间的朋友，也可以直接看第2章N分钟入门，可以让你在最快的时间内入门。对于时间充沛的朋友， 建议多看看文档。因为作者一再的强调 it is worth reading the documentation ，第5章在Ant中使用Checkstyle说明了在ant下的用法。第6章在Eclipse中使用Checkstyle说明了Eclipse的插件Check clipse的用法.对于初次接触代码规范的朋友，我安排了第3章常用的检查，里面是个人以为满足大多数公司要求的检查，包括一个配置文件。第7章各种检查是各种检查的详细用法，读起来比较枯燥，建议象查字典那样有需要时翻阅，所以放在最后。
《Checkstyle中文手册》目录
目录
1.前宣
1.介绍
2.N分钟入门
3.常用的检查
4.用的最多的20%功能
5.在Ant中使用Checkstyle
6.在Eclipse中使用Checkstyle
7.各种检查
1.1.概述
1.2.特点
1.3.下载
3.1.典型的配置文件
5.1.N分钟极速入门
5.2.安装与配置
5.3.典型例子
5.4.checks tle任务的参数
5.5.可以嵌套的ant元素
6.1.下载和安装
6.2.配置方法
6.3.使用
6.4.常见问题
7.1.如何配置检查
7.2.JavaDoc注释
7.3.命名约定
7.4.文件头
7.5.Imports
7.6.长度限制
7.7.空格
7.8.关键字
7.9.对区域(empty block) 的检查
7.10.编码的检查
7.11.Class的设计
721类和接的iava doc
722.方法的lava doc
7.2.3.方法的javadoc
7.2.4.变量的javadoc
731.模块一览
7.3.2.注意
7.5.1.import中避免星号 ”
7.5.2.没用的import
7.6.1.文件长度
7.6.2.每行长度
7.6.3.方法长度
7.6.4.方法的参数个数
7.7.1.万法名与左边圆括号之间
7.7.2.因括号附近的空格
773.类型转换中圆括号附近的室格
774.对 Tab 的检查
7.7.5.特定符号后的空格
7.8.1.关键字的出现顺序
7.8.2.多余的关键字
7.9.2.对左侧括号(的检查(略)
7.9.3.需要括号的区域
7.9.4.对右侧括号}的检查(略)
7.9.5.不必要的括号
7.10.1.数组尾巴的逗号
7.10.2.避兔内联(inline) 条件判断
7.10.3.override的equals方法
7.10.4.空语句(statement)
7.10.5.equals和hashCode方法
7.10.6.应该声明成nal的局部变量
7.10.7.个合适的初始化
7.10.8.不合适的token
7.10.9.内部赋值语包
7.10.10.魔法数
7.10.11.丢了default分支的switch
7.10.12.被更改的循环控制变量
7.10.13.多余的throw
7.10.14.未被简化的条件表达式
7.10.15.未简化的布尔返回值
7.10.16.字串(String) 的比较
7.10.17.嵌套的i层次
7.10.18.套的try层次
7.10.19.调用父类的clone
7.10.20.父类的final ie
710.21.不合理的catch
7.10.22.不合理的throws
7.10.23.package声明
7.10.24.JUnit TestCase
7.10.25.re um语句的数量
710.26.声明的题序
710.27.参数被赋伍
7.10.28.详尽的变量初始化
7.10.29.switch语句的default位置排在最后
7.10.32.多个内容相巨的字符串变量
7.10.33.同一行禁止声明多个变量
7.10.34.不使用this
7.10.35.不必要的圆括号
7.11.1.可见的修改方法
7.11.2.Final class
7.11.3.Interface ls Type
7.11.4.隐藏工具类的构造方法
7.11.5.万便继承(extention) 而进行的设计
7.11.6.throws的数量
7.12.1.Strict Duplicate Code严格的重复代码检查
7.13.1.布尔表达式的复杂度
7.13.2.类数据的抽象耦合
7.13.3.类的分散复杂度
7.13.4.函数的分支复杂度
7.13.5.N path复杂度
7.14.1.禁止使用的表达式
7.14.2.文件结尾的回车
7.14.3.To do注释
7.14.4.翻译属性文件
7.14.5.没有被注释掉的Main函数
7.14.6.大写的L
7.14.7.声明数组的风格
7.14.8.in al型的参数
7.14.9.缩进
71410与代码同行的注群
7.14.11.必须出现的字符串
7.12.重复的代码
7.13.各种量度
7.14.杂项
2.1.测试如何使用checkstyle的项目
2.2.开启Checkstyle
2.3.代码窗中的错误提示
2.4.Problems窗中的错误提示
2.5.增加了class的注释后的效果图
2.6.使用自定义的Checkstyle配置文件
2.7.定制配置的检查结果
2.8.修正后的定制配置的检查结果
5.1.在Ant环境下C