《Checkstyle4.3中文手册》草稿版,请大家多给意见!想加入OpenDoc.

访问量: 832

想加入OpenDoc的草稿版,全文见附件,以下COPY自序言……

Checkstyle是非常优秀的代码规范检查软件,可以大幅的提高代码质量,
当项目的开发人员比较多时,用它来统一代码风格是很有必要的。
本文的写作,是由于公司的质量管理部门对代码格式进行了要求。
在网上也没有发现有比较详细全面的中文文档。所以参考Checkstyle4.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的插件Checkclipse的用法。
对于初次接触代码规范的朋友,我安排了第 3 章 常用的检查 ,里面是个人以为满足大多数公司要求的检查,包括一个配置文件。
第 7 章 各种检查 是各种检查的详细用法,读起来比较枯燥,建议象查字典那样有需要时翻阅,所以放在最后。
[img]file:///D:/obp/output/docs_for_checkstyle/zh-cn/html/images/caution.png" alt="[小心][/img]欢迎意见为了加入OpenDoc , 欢迎各位朋友指出文档中的任何错误和不足,也可以给我任何意见。请Email给我:shensiwei(at)sina.com
希望本文对您有用。谢谢!

订阅/RSS Feed

Subscribe

分类/category