2008-03-04
《Checkstyle4.3中文手册》草稿版,请大家多给意见!想加入OpenDoc.
关键字: checkstyle 代码检查 中文文档
想加入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 章 各种检查是各种检查的详细用法,读起来比较枯燥,建议象查字典那样有需要时翻阅,所以放在最后。
欢迎意见为了加入OpenDoc , 欢迎各位朋友指出文档中的任何错误和不足,也可以给我任何意见。请Email给我:shensiwei(at)sina.com
希望本文对您有用。谢谢!
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 章 各种检查是各种检查的详细用法,读起来比较枯燥,建议象查字典那样有需要时翻阅,所以放在最后。
欢迎意见为了加入OpenDoc , 欢迎各位朋友指出文档中的任何错误和不足,也可以给我任何意见。请Email给我:shensiwei(at)sina.com
评论
lszone
2008-03-13
非常感谢,最近我也想利用它来做代码规范方面的工作,帮助不小,感谢
fangsimple
2008-03-08
打开后,点“查看”——》“编码”——》“自动选择”或“UTF-8” 就可以了。
这样就解决了,呵呵
没想到这个问题
这样就解决了,呵呵
没想到这个问题
sg552
2008-03-05
fangsimple 写道
我用ie查看怎么会是乱码呢
是不是你的IE的编码没有指定成“自动选择”?
打开后,点“查看”——》“编码”——》“自动选择”或“UTF-8” 就可以了。
fangsimple
2008-03-05
我用ie查看怎么会是乱码呢
icelander
2008-03-05
不错,以前用过~
longgue
2008-03-04
支持,以前自己也试着翻译了一下,可是没坚持,半途而废了!
发表评论
提醒: 该博客已发表在公共论坛,博客所有留言会成为论坛回贴,留言请注意遵守论坛发贴规则
- 浏览: 12810 次
- 性别:

- 来自: 北京

- 详细资料
搜索本博客
最近加入圈子
最新评论
-
Jalopy在Eclipse下的使用
sg552 写道 1. 下载和安装 ...
-- by wyyhzc -
《Checkstyle4.3中文手册 ...
非常感谢,最近我也想利用它来做代码规范方面的工作,帮助不小,感谢
-- by lszone -
Jalopy在Eclipse下的使用
3. 配置 在Eclipse中进行Jalopy配置也很容易,先用左键点 ...
-- by sg552 -
Jalopy在Eclipse下的使用
2. 使用 可以格式化一个文件,一个文件夹,或者整个项目 ...
-- by sg552 -
Jalopy在Eclipse下的使用
1. 下载和安装截止到2008-03-06,可以在这里下载:Eclip ...
-- by sg552






评论排行榜