国家重点XXXX项目--代码开发规范.doc

附件四 国家发展改革委网上办公系统二期项目 代码开发规范 编制单位：北京AAAA信息产业股份有限公司 编 制 人： 编制日期：二○一一年四月 国家发展改革委网上办公系统二期项目开发代码规范 — PAGE I — 目 录 TOC \o "1-4" \h \z \u 第1章 前言 1 1.1 目的 1 1.2 内容 1 1.3 定义 2 1.4 适用范围 2 第2章 JAVA源码编写规范 2 2.1 标识符的命名规范 2 2.2 公认的命名约定 3 2.3 源文件注释的规范 3 2.3.1 Java中的注释类型 3 2.3.2 历史信息说明 4 2.3.3 类头部注释 4 2.3.4 变量常量注释 5 2.3.5 方法头部注释 5 2.3.6 代码注释 5 2.4 文档排版的规范 6 2.4.1 缩进 6 2.4.2 空格和空行 6 2.4.3 页面宽度 7 2.4.4 长参数表达式的换行 7 2.4.5 括号的匹配 8 2.4.6 import语句 8 第3章 JSP源代码规范 9 3.1 页面目录结构 9 3.2 文件命名规范 10 3.3 HTML文件样式 11 3.4 使用标签代替Java编码 12 3.5 表单显示规范 12 3.6 缩进和对齐 13 3.7 注释 14 3.8 JavaScript文件 14 北京AAAA信息产业股份有限公司 第 PAGE 15页 前言 目的 为规范国家发展改革委网上办公系统二期项目（以下简称“发改委二期项目）系统的开发代码管理，特制定开发代码规范。通过该规范，我们希望达到以下目标： 增加开发过程代码的强壮性、可理解性、易维护性；减少有经验和无经验开发人员编程所需的脑力工作； 在项目范围内统一代码风格； 使新的开发人员快速适应项目氛围； 更好的完成发改委二期项目的开发，以及后期的维护。 内容 本规范采用与国际代码规范基本一致的代码规范，并使得能在开发阶段将代码规范落实到项目组中的每一个有关人员。统一代码开发规范，提高代码的质量和可维护性。 提供事务、异常处理、文件处理等标准服务，规范各模块的处理方法。 制订代码开发规范，撰写核心代码规格及单元测试指针以建立测试导向的开发目标。 本规范包括对以下两个部分的规范要求：Java源文件和JSP源文件。将JSP单独提出作为一部分加以规范，目的是为了让JSP源代码符合SUN提出的标准，而不是像一个Java文件。 规范主要分为以下几个个方面： 手工编写代码时需要注意的部分，如命名和注释； 代码排版时需要注意的部分，如缩进，换行等。这一部分可通过编辑器辅助实现； 其它的一些问题，如某些技巧和常用解决方案。 定义 本规范是针对Java语言的，采用以下的术语描述： 规范：编程时强制必须遵守的原则。 约定：被大家广泛认同的一些规范。 建议：编程时必须加以考虑的原则。 说明：对此规则或建议进行必要的解释。 示例：对此规则或建议给出的例子。 适用范围 适用于国家发展改革委网上办公系统二期项目建设。 JAVA源码编写规范 标识符的命名规范 特殊用途的文件使用表示其用途的后缀，如*Test.java，*Temp.java。 使用可以自说明(含义清晰)的英文描述符，如firstName。 循环里的简单递增（减）变量可以被命名为 “i”，其它地方不允许这样。 尽量采用项目所涉及领域的术语，并且保留一份术语的中英对照表。 必要时可以使用汉语拼音缩写(尽量避免)。 采用大小写混合，提高名字的可读性。 尽量少用缩写，但大家都认可的缩写除外。 缩写词语的所有字母都必须大写。 严禁使用下划线作为名字的首末字母，如_name， name_。 严禁使用数字，如arg0，arg1等 说明：如果对命名有不明白的地方，可以参考JDK的源代码。 建议：考虑到大多数Java开发者的习惯，尽量不要使用匈牙利命名法。 公认的命名约定 类型 命名约定 示例 包 全部小写。 标识符用点号分隔开来。 全局包的名字用你的机构的 Internet 保留域名开头 ject 类，接口 类的名字应该使用名词。 每个单词第一个字母应该大写。 避免使用单词的缩写，除非其缩写已广为人知，如HTTP Class Hello ; Class HelloWorld ; Interface Apple ; 方法 第一个单词一般是动词 第一个字母是小写，但是中间单词的第一个字母是大写 Getter方法名一般为getXxx