引言
文档目的
本文试图提供一套编写高效可靠的 Java 代码的标准、约定和指导。它们以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强。通过遵循和改进这些程序设计标准,使各项目产生的代码有更好的一致性,并提高软件开发团队的生产效率。
本规范适用于采用J2EE规范的项目,所有项目中的Java代码(含JSP,SERVLET,JAVABEAN,EJB,开发工具生成的代码框架等)均应遵守这个规范。同时,也可作为其它项目的参考。
规范原则:
遵循业界标准
可读性强,意义清楚
整洁严谨、风格统一
文档预期读者
本文档的预期读者包括J2EE项目开发组全体成员:技术管理人员、系统设计人员、系统开发人员、系统测试人员、系统维护人员、推广培训人员及其他相关人员。
文档适用范围
本文档适用于所有与Java相关的开发。
Java代码开发规范
命名规范
文件 File
| Naming Convention 命名规范 | Must Follow or Not 是否必须遵循 | Example 范例 |
| 文件名命名方法, 单词首字母大写 | 必须 | ThisIsTest.java |
| 备注: | ||
包 Package
| Naming Convention 命名规范 | Must Follow or Not 是否必须遵循 | Example 范例 |
| 采用联科Internet域名格式命名 | 必须 | com.linkey.package |
| Package名称小写 | 必须 | |
| Package名称必须为单数 | 必须 | 使用: com.linkey.servlet 不使用: com.linkey.servlets |
| 备注:联科标准Internet域名为 www.linkey.com.cn ,所以包结构以com.linkey为前缀 | ||
接口Interface
| Naming Convention 命名规范 | Must Follow or Not 是否必须遵循 | Example 范例 |
| 英语单词字头大写,其他可以用大写或小写 | 必须 | ThisIsAnInterfaceName |
| 接口要I开头 | 必须 | ISomeInterface |
| 备注: | ||
接口的实现
| Naming Convention 命名规范 | Must Follow or Not 是否必须遵循 | Example 范例 |
| 英语单词字头大写,其他可以用大写或小写 | 必须 | ThisIsAnInterfaceName |
| 接口的实现要Impl结尾 | 必须 | SomeInterfaceImpl |
| 备注: | ||