检查的Java编程规范.docVIP

JTest检查的Java编程规范 目 录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc 1. 前言 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 2. JTest检查的编程规范 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 2.1. 编码规则 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 2.2. 按合约设计规则 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.3. EJB规则 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.4. 代码格式规则 PAGEREF _Toc \h 6 HYPERLINK \l _Toc 2.5. 垃圾回收规则 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.6. 全局静态分析规则 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.7. 初始化规则 PAGEREF _Toc \h 8 HYPERLINK \l _Toc 2.8. 国际化规则 PAGEREF _Toc \h 8 HYPERLINK \l _Toc 2.9. Javadoc注释规则 PAGEREF _Toc \h 8 HYPERLINK \l _Toc 2.10. JUnit测试用例规则 PAGEREF _Toc \h 10 HYPERLINK \l _Toc 2.11. 类的统计信息 PAGEREF _Toc \h 10 HYPERLINK \l _Toc 2.12. 其它规则 PAGEREF _Toc \h 10 HYPERLINK \l _Toc 2.13. 命名规范 PAGEREF _Toc \h 11 HYPERLINK \l _Toc 2.14. 面向对象编程规则 PAGEREF _Toc \h 12 HYPERLINK \l _Toc 2.15. 优化规则 PAGEREF _Toc \h 12 HYPERLINK \l _Toc 2.16. 预防BUG规则 PAGEREF _Toc \h 14 HYPERLINK \l _Toc 2.17. 工程项目统计 PAGEREF _Toc \h 15 HYPERLINK \l _Toc 2.18. 兼容性规则 PAGEREF _Toc \h 15 HYPERLINK \l _Toc 2.19. 安全性规则 PAGEREF _Toc \h 15 HYPERLINK \l _Toc 2.20. Servlet规则 PAGEREF _Toc \h 16 HYPERLINK \l _Toc 2.21. 线程及同步规则 PAGEREF _Toc \h 16 HYPERLINK \l _Toc 2.22. 不使用的代码规则 PAGEREF _Toc \h 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