JTest检查Java编程规范.doc

JTest检查的Java编程规范 目 录 1. 前言 3 2. JTest检查的编程规范 3 2.1. 编码规则 3 2.2. 按合约设计规则 4 2.3. EJB规则 4 2.4. 代码格式规则 6 2.5. 垃圾回收规则 7 2.6. 全局静态分析规则 7 2.7. 初始化规则 8 2.8. 国际化规则 8 2.9. Javadoc注释规则 8 2.10. JUnit测试用例规则 10 2.11. 类的统计信息 10 2.12. 其它规则 10 2.13. 命名规范 11 2.14. 面向对象编程规则 12 2.15. 优化规则 12 2.16. 预防BUG规则 14 2.17. 工程项目统计 15 2.18. 兼容性规则 15 2.19. 安全性规则 15 2.20. Servlet规则 16 2.21. 线程及同步规则 16 2.22. 不使用的代码规则 17 前言 JTest可以对Java代码进行静态和动态分析，可以规范化统一编程规定和帮助开发人员预防潜在的编程错误。本文详细描述了JTest中采用的编程格式。 JTest检查的编程规范 JTest中共有518条规定，结合实际情况，选取了其中的199条。已经将适合的规则导出到文件中，开发人员只需将规则导入到JTest中即可。 规则导出文件 《JTest代码审查规定.property》 如何导入到JTest中 在JTest主菜单中，选择“Jtest”“Jtest Configurations”，弹出JTest的“TEST Configurations”设置对话框，在左端的面板中选择“User-Defined”，点击鼠标右键的“Import”菜单导入上述的property文件即可。 以下的编程规则来源于JTest检查规范，对于其中的适合部分进行了说明。 【说明】对于每条规则的利弊，请参见JTest联机帮助。 编码规则 CODSTA.ACDO-1避免在字符串常量前使用“new”操作符； CODSTA.ASI-3不用！对于任何没有使用非静态变量类成员变量的方法使用“static”修饰符； CODSTA.AUVT-3不用！对于“List”和“Set”的接口实现的类型使用“List”和“Set”声明； CODSTA.CLONE-2对于Cloneable 类声明“clone() throws CloneNotSupportedException“； CODSTA.CLS-4在比较是否相等时，将常量放在左边； CODSTA.CRS-4不用！在比较是否相等时，将常量放在右边； CODSTA.DCI-5不用！在interface中定义常量； CODSTA.DCTOR-3不用！在任何可能的情况下，都定义一个缺省的构造函数； CODSTA.DUN-5不用！在一个方法中，避免使用3个以上的“！”操作符； CODSTA.IMPT-4不用！不允许使用通配符“*”import类； CODSTA.IMPT2-4不用！使用通配符import类； CODSTA.ISACF-5可以考虑；避免在接口中定义常量； CODSTA.LONG-2使用“L”修饰符而不是“l”来表示“long”整数； CODSTA.MVOS-3避免在一个语句中声明多个变量； CODSTA.NCAC-2避免在“abstract”类的构造函数中调用其“abstract”方法； CODSTA.NCE-4在“catch”语句中避免使用“Exception”、“RuntimeException”和“Throwable”； CODSTA.NEA-1避免嵌套赋值； CODSTA.NTX-3避免抛出抛出“Exception”，而应该总是抛出“Exception”的子类； CODSTA.OGM-3不用！按照方法的名称顺序定义方法； CODSTA.OTOSM-3不用！总是重载“toString()”方法； CODSTA.OVERLOAD-4不用！避免重载多个相同参数的方法； CODSTA.OVERRIDE-4当重载“Object.equals()”方法时，总是重载“Object.hashCode()”方法； CODSTA.PML-4总是将“main()”方法放在最后； CODSTA.SMC-3不用！避免“switch”语句含有太多的“case”语句； CODSTA.UCC-2不用！对于只提供静态成员和方法的工具类，使用“private”的构造函数； CODSTA.UCDC-2不用！对于只提供静态成员和方法的工具类，提供“private”的构造函数； CODSTA.USN-2避免使用魔术常数； CODSTA.VDT-1避免在一个语句中声明多种类型的变量； 按合约设计规则 共13个规则，全部不用！