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

想加入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

希望本文对您有用。谢谢！

评论

10 楼 hantsy 2008-12-31  

既然用docbook，代码中的中文说明，完全可以用callout放到代码外面。。。

9 楼 hantsy 2008-12-31  

编译一份pdf嘛。

8 楼 hantsy 2008-12-31  

eclipse-cs 应该比checkeclipse的配置性要强一些。。。而且后者好久没有更新了。

7 楼 hantsy 2008-12-31  

现在Checkstyle已经在开发5.0。

6 楼 lszone 2008-03-13  

非常感谢，最近我也想利用它来做代码规范方面的工作，帮助不小，感谢

5 楼 fangsimple 2008-03-08  

打开后，点“查看”——》“编码”——》“自动选择”或“UTF-8” 就可以了。

这样就解决了，呵呵

没想到这个问题

4 楼 sg552 2008-03-05  

fangsimple 写道

我用ie查看怎么会是乱码呢

是不是你的IE的编码没有指定成“自动选择”？

打开后，点“查看”——》“编码”——》“自动选择”或“UTF-8” 就可以了。

3 楼 fangsimple 2008-03-05  

我用ie查看怎么会是乱码呢

2 楼 icelander 2008-03-05  

不错,以前用过~

1 楼 longgue 2008-03-04  

支持,以前自己也试着翻译了一下,可是没坚持,半途而废了!