软件项目的编码--20140525.docVIP

软件项目的编码 一、编码文档 编码阶段的产品是按照代码标准和规范编写的代码，必要的时候进行部署。编码提交的文档包括代码标准规范和源代码。 二、项目案例 项目案例名称：综合信息管理平台 项目案例文档：《综合信息管理平台编码规范及其代码说明》 1、导言 1.1 目的 该文档的目的是描述综合信息管理平台的编码规范和对代码的说明，其主要内容包括编码规范，命名规范，注释规范，语句规范，声明规范，目录设置，代码说明。 本文档的预期读者是开发人员，项目管理人员，质量保证人员。 1.2 范围 该文档定义了本项目的代码编写规范，以及部分代码描述和相关代码的说明。 1.3 术语定义 Class（类）：Java程序中的一个程序单位，可以生成很多实例。 Packages（包）：由很多类组成的工作包。 1.4 引用标准 （1）企业文档格式标准V1.1，北京长江软件有限公司。 （2） 1.5 参考资料 （1） 1.6 版本更新信息 本文档版本更新记录如表X-XXX所示。 表X-XXX 版本更新记录 修改编号 修改日期 修改后的版本 修改位置 修改内容概述 000V001 全部 初始发布 2、编码书写格式规范 严格要求编码书写格式是为了使程序整齐美观，易于阅读，风格统一，程序员对规范书写的必要性要有明确的认识。建议程序使用Eclipse工具开发，格式规范预先在工具中设置。 2.1 缩进排版 4个空格作为一个缩进排版单位。 2.2 行长度 尽量避免一行的长度超过80个实际字符，用于文档中的例子应该使用更短和行长，长度一般不超过70个字符。 2.3 断行规则 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开： （1）在一个逗号后面断开。 （2）在一个操作符前面断开。 （3）尽量选择较高运算级别处断开，而非较低运算级别处断开。 （4）如果是以上规则导致代码混乱或者使代码都堆挤在右边，那就代之以缩进8个空格。 2.4空行 空行将逻辑相关的代码段分隔开，以提高可读性。下列情况应该总是使用两个空行： （1）一个源文件的两个片段（section）之间。 （2）类声明和接口声明之间。 下列情况应该总是使用一个空行： （1）两个方法之间。 （2）方法内的局部变量和方法的第一条语句之间。 （3）块注释或单行注释之间。 （4）一个方法内的两个逻辑段之间。 3、命名规范 命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码。 3.1 包（Package） 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com、edu、gov、mil、net、org，或1981年ISO3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门（department）、项目（project）、机器（machine）或注册名（login names）。如： com.sun.eng 3.2 类（Class） 类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。尽量使用类名简洁而富于描述性。使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL、HTML）。 3.3 接口（Interface） 大小写规则与类名相似。 3.4 方法（Method） 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 3.5 变量（Variable） 采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应该以下划线或美元符号开头，尽管这在语法上是允许的。变量名应该易于记忆，且能够指出其用途。尽量避免单个字符的变量名，除非是一次性临时变量。 3.6 实例变量（Instance Variable） 大小写规则和变量名相似，除了前面需要一个下划线。 3.7 常量（Constant） 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。 4、声明规范 程序中定义的数据类型，在计算机中都要为其开辟一定数量的存储单元，为了不造成资源的不必要的浪费，所以按需定义数据的类型，声明包、类以及接口。 4.1 每行声明变量的数量 推荐一行一个声明，因为这样有利于写注释。不要将不同类型变量的声明放在同一行！ 4.2 初始化 尽量在声明局部变量的同时初始化，唯一不这么做的理由是变量的初始值依赖于某些先前发生的布局。 4.3 布局 只在代码块的开始处声明变量（一个块是指任何被包含在｛｝中间的代码）。不要在首次用到该变量时才声明它，这会把注意力不集中的程序员搞湖涂，同时妨碍代码在该作用域内的可移植性。 4.4 包的声明 在多数Java源程序中，第一个非注释行是包语句。 packa