（转载）SpringSide代码轨范

（转载）SpringSide代码规范
前言

??? 本文档反映的是SpringSide 团队的编码规范，同时推荐所有使用SpringSide框架的开发人员遵循。

??? 本文档基本遵循，补充了其中没有说明或者有所改动的地方。

版权声明???

??? 本规范由维护，相关评论与意见请发至springside@gmail.com，转载请注明出处。

规范等级说明级别I:?? 默认级别，要求所有项目中的所有成员遵守。 级别II: ?建议所有项目中的所有成员遵守。 级别III: 鼓励各个项目根据实际情况执行。 1.格式与命名规范(Formating and Naming Conventions)1.1??缩进

? 使用Tab缩进，而不是空格键--将缩进2，4，8字符的选择权留给阅读者。

1.2 换行

?? 每行120字符--因为已是1024*768的年代。

? ?if,for,while语句只有单句时，如果该句可能引起阅读混淆，需要用" {"和"}"括起来，否则可以省略。

与 的代码校验功能已经排除了很多问题。

?? 再配合使用，，三重检查，总共五层的校验涵盖了Java编码大部分的Guide Line。

?? 如果要求不苛刻，可以只使用Eclipse或IDEA 搭配 Checkstyle的两重保湿效果。

Eclipse：在Windows->Preferences->Java-Compiler->Errors/Warnings中，按本文档将一些原来Ignore的规则打开。
也可以将springside团队预设在/tools/codereviewer/eclipse.check.prefs的内容拷贝到项目的.setting/org.eclipse.jdt.core.prefs 文件中。 IDEA：在Setting->Errors中设定规则，调用Analyzer->Inspece Code进行校验。 CheckStyle：安装，在Windows->Preferences->CheckStyle导入springside团队预设在/tools/codereviewer/springside_check.xml的规则。 PMD：安装，Windows->Preferences->PMD清除原来所有规则，导入springside团队预设在/tools/codereviewer/springside_pmd.xml的规则。 FindBugs：安装，在项目属性->FindBugs中，取消下列警告MS/EI/EI2/ ，?SnVI/SE/WS/RS ，ST/NP/UwF/SS/UuF|UrF|SIC。

5.参考资料

Sun MicroSystem； ? Scott W. Ambler?等著； 代码检测工具的规则： ， ，

查看更多 下一篇