《Java开发标准》.docVIP

Java 编码规范 昆明达内科技有限公司 J2EE 应用技术规范--Java 编码规范 （V1.0） 研发部 贾强生 2010年 8 月 目 录 昆明达内科技有限公司 1 1. 引言 4 1.1 文档目的 4 1.2 文档预期读者 4 1.3 文档适用范围 4 2 Java 代码开发规范 5 2.1 命名规范 5 2.1.1 文件 File 5 2.1.2 包 Package 5 2.1.3 接口 Interface 6 2.1.4 类 Class 6 2.1.5 方法 Method 6 2.1.6 参数 Parameter 7 2.1.7 变量 Variable 7 2.1.8 实例变量 Instance Variable 7 2.1.9 常量 Constant 8 2.1.10 数组 Array 8 2.2 格式规范 8 2.2.1 版权信息 Copyright Information 8 2.2.2 注释 Comment 9 2.2.3 缩进 Indentation 11 2.2.4 空格 Space 11 2.2.5 空行 Blank Line 11 2.2.6 行长度 Line Length 12 2.2.7 换行 New Line 12 2.2.8 圆括号 Parentheses 13 2.2.9 大括号 Big Brackets 13 2.3 语句规范 14 2.3.1 简单语句 Simple Statement 14 2.3.2 条件语句 Condition Statement 14 2.3.3 分支语句 Switch Statement 15 2.3.4 循环语句 Loop Statement 15 2.3.5 包和引入语句 Packet and Import Statement 16 2.3.6 声明语句 Declare Statement 17 2.3.7 例外控制语句 Exception Control Statement 18 2.3.8 类和接口 Class and Interface 18 2.3.9 构造/析构 Constructor/Finalizer 19 2.3.10 方法 Method 19 2.3.11 属性 Attribute 20 2.3.12 SQL 语句 SQL Statement 22 2.4 日志规范 23 2.5 一般性规范 23 2.6 其它代码开发规范 25 2.6.1 多线程 Multi-Threading 25 2.6.2 Servlet 25 2.6.3 JDBC 26 引言 文档目的 本文试图提供一套编写高效可靠的 Java 代码的标准、约定和指导。它们以 安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。通过遵循和改 进这些程序设计标准，使各项目产生的代码有更好的一致性，并提高软件开发团 队的生产效率。 本规范适用于采用 J2EE 规范的项目，所有项目中的 Java 代码（含 JSP， SERVLET，JAVABEAN，EJB，开发工具生成的代码框架等）均应遵守这个规范。同 时，也可作为其它项目的参考。要求项目都要遵循，并作为项目评审与验收依据。 规范原则： ? 遵循业界标准 ? 可读性强，意义清楚 ? 整洁严谨、风格统一 文档预期读者 本文档的预期读者包括 J2EE 项目开发组全体成员：技术管理人员、系统设 计人员、系统开发人员、系统测试人员、系统维护人员、推广培训人员及其他相 关人员。 文档适用范围 本文档适用于所有与 Java 相关的开发。 Java 代码开发规范 命名规范 文件 File Naming Convention 命名规范 Must Follow or Not 是否必须遵循 Example 范例 文件名命名方法, 单词 首字母大写 必须 ThisIsTest.java 备注： ? 2.1.2 包 Package Naming Convention 命名规范 Must Follow or Not 是否必须遵循 Example 范例 采用昆明达内 Internet 域名 名格式命名 必须 .tarena.package Package 名称小写 必须 Package 名称必须为单 数 必须 使用: .tarena.util 不使用: .tarena.utils 备注：达内标准 Internet 域名为 ,所以包结构以 cn. 为前缀 2.1.3 接口 Interface Naming Convention 命名规范 Must Follow or Not 是否必须遵循 Example 范例 英语单词字头大写,其 他可以用大写或小写 必须 ThisIsAnInterfaceName