JAVA源代码规范.doc

JAVA代码规范 (初稿) 2004.4  版本更新信息 本版本创建/修改、维护、批准涉及人员如下： 创建/修改者：XX 维护者：XX 批准者：XX 具体版本更新记录如表1-1： 表1-1 版本更新记录 版本号 修改确认日期 修改人 修改位置 修改方式 （AMD） 修改内容概述 V1.0 2004.4 XX 全部 A 初始版本发布 修改方式：A－增加 M－修改 D－删除  目的 本文提供一整套编写高效可靠的 Java 代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强灵活性。通过遵循一套通用的程序设计标准，显著提高 Java 软件开发者的生产效率，为开发团队的程序设计带来更大的一致性，使软件开发团队的效率明显提高。 规范的执行 本文档适用于公司内进行软件开发的所有技术人员，即公司内软件开发人员编写的所有源代码都必须遵循本规范。 除临时性项目之外的任何项目均应严格按照此标准执行，“临时性项目”指： 为市场推广目的而编写的示程序 为一次性用途而编写的临时性小程序 为学习目的而编写的测试程序 文档类别 本文档属标准规范类的项目限制级文档，未经总经理及总经理授权人员批准，不得提供公司以外的人员阅读和使用。 版本更新条件 本文档的定期评审时间为每年的1月，评审及修订步骤依据SEPG工作规范规定。此外，如遇下列条件可进行评审，并根据评审结果决定是否需要进行修订： 本文档所列的引用的标准已经更新。 本文档的使用者若对本文档有任何评论、建议或意见，请通过企业内部网络发电子邮件给SEPG，所收到的电子邮件将会在评审和修订时给予充分的考虑。 使用对象 本文档的使用对象包括： 项目管理者 质量保证人员 软件开发人员  目 录 1 介绍 7 1.1 为什么要有编码规范 7 2 通用代码格式 7 2.1 文件组织 7 2.2 缩进 8 2.3 行长度 8 2.4 换行 8 2.5 空行 10 2.6 空格 10 2.7 注释 11 2.7.1 注释约定 11 2.7.2 实现注释的格式 12 2.7.3 文档注释 13 2.7.4 快速浏览 javadoc 13 2.8 声明 14 2.8.1 每行声明变量的数量 14 2.8.2 初始化 14 2.8.3 布局 15 2.8.4 类和接口的声明 15 2.9 语句 16 2.9.1 简单语句 16 2.9.2 复合语句 16 2.9.3 返回语句 16 2.9.4 if，if-else，if else-if else语句 16 2.9.5 for语句 17 2.9.6 while语句 17 2.9.7 do-while语句 17 2.9.8 switch语句 17 2.9.9 try-catch语句 18 2.10 SQL 18 3 命名规范 19 3.1 总则 19 3.2 项目命名 19 3.3 命名规则 20 3.4 变量命名机制 20 3.4.1 基本类型变量命名规则：变量类型标识+逻辑名 20 3.4.2 一般常用对象命名规则 21 3.4.3 临时变量命名规则 22 3.4.4 全局变量、成员变量、局部变量命名规则 22 3.4.5 常量命名机制 22 3.5 HTML 元素变量命名机制 22 3.6 JSP 文件命名机制 22 4 类、接口、包和编译单元的标准 23 4.1 类的标准 23 4.1.1 命名类 23 4.1.2 注释类 23 4.2 接口标准 24 4.2.1 命名接口 24 4.2.2 注释接口 24 4.3 包的标准 24 4.3.1 命名包 24 4.3.2 注释包 25 4.4 编译单元标准 25 4.4.1 命名编译单元 25 4.4.2 注释编译单元 25 5 字段标准 （字段/属性） 26 5.1 字段可见性 26 5.2 注释一个字段 26 5.3 使用存取成员方法 27 5.3.1 存取函数的可见性 27 5.3.2 一定要初始化静态字段 27 6 成员函数和方法标准 28 6.1 命名函数和成员方法 28 6.2 命名存取成员函数和方法 28 6.3 命名构造函数 29 6.4 成员函数和方法的可见性 29 6.5 成员函数和方法参数标准 30 6.5.1 命名参数 30 6.5.2 注释参数 30 6.6 注释成员函数和方法 30 7 编程惯例 32 7.1 提供对实例以及类变量的访问控制 32 7.2 引用类变量和类方法 32 7.3 常量 32 7.4 变量赋值 32 8 其它惯例 33 8.1 圆括号 33 8.2 返回值 33 8.3 条件运算符?前的表达式 33 8.4 特殊注释 34 9 代码范例 34 9.1 源文件范例 34 10 缩写说明 35 11