代码质量实践之统一代码风格

    前几篇文章中一直在强调 代码质量,理论性很强,但实践性很低,平时我也关注这方面的 工具和平台,以前开发中经常遇到很多人的代码风格不统一,在新的公司我发现这方面已经做的不错了,于是我总结了一下,希望对困惑于代码风格不能统一的各位有所帮助。
 
1.统一eclipse版本,最好由技术委员会统一制定eclipse标准,安装好各种插件,比如maven插件、findbugs、scm插件等等。我以前遇到过如果eclipse版本不一样,format出来的代码风格也不一样。
 
2.统一format和clean up模板,最好还是制定一个公司级别的format和clean up模板,然后要求每个人都导进去。如果没有合适的format和clean up模板,建议采用eclipse默认的即可。
 
3.统一注释风格,我们有时候需要知道代码创建和修改的作者、时间和原因等等,这些因素对后续代码的维护有莫大的帮助,但是很多人都忽略了这点,所以我建议注释风格也需要统一。
 
/** * xxx公司版权所有 * @author xuze(cantellow) * @email [email protected] * ${date} ${time} * ${todo} * @modify */
 最后一点,也是最重要的一点,很多人都执行上面的步骤,但是很少人去执行ctrl+shift+f,解决方法是配置“save actions”,位置是windows—》preferences—》java—》editor—》save actions,将“format source code”打上勾,另外你还可以添加一些“additional actions”。
你所定制的这些规则,当你保存文件时会触发,也就是说,当每一次编辑文件执行保存动作时,都会执行format操作以及附带的additional操作,这就强制了format,我相信有人不愿意去执行ctrl+shift+f,但没有不修改并保存源文件的吧。
 
下面是我的“save actions”配置:
<br><img src="http://dl.iteye.com/upload/attachment/520733/ef2cd721-26a0-38dc-9220-e4d87a5ed9b3.png" alt="">
 

猜你喜欢

转载自lucene3212.iteye.com/blog/1143162