软件项目的编码--20140525

软件项目的编码一、编码文档编码阶段的产品是按照代码标准和规范编写的代码，必要的时候进行部署。编码提交的文档包括代码标准规范和源代码。二、项目案例项目案例名称：综合信息管理平台项目案例文档：《综合信息管理平台编码规范及其代码说明》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版本更新记录修改编号修改日期修改后的版本修改位置修改内容概述00020131215V001全部初始发布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）或注册名（loginnames）。如：com.sun.eng3.2类（Class）类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。尽量使用类名简洁而富于描述性。使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL、HTML）。3.3接口（Interface）大小写规则与类名相似。3.4方法（Method）方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。3.5变量（Variable）采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应该以下划线或美元符号开头，尽管这在语法上是允许的。变量名应该易于记忆，且能够指出其用途。尽量避免单个字符的变量名，除非是一次性临时变量。3.6实例变量（InstanceVariable）大小写规则和变量名相似，除了前面需要一个下划线。3.7常量（Constant）类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。4、声明规范程序中定义的数据类型，在计算机中都要为其开辟一定数量的存储单元，为了不造成资源的不必要的浪费，所以按需定义数据的类型，声明包、类以及接口。4.1每行声明变量的数量推荐一行一个声明，因为这样有利于写注释。不要将不同类型变量的声明放在同一行！4.2初始化尽量在声明局部变量的同时初始化，唯一不这么做的理由是变量的初始值依赖于某些先前发生的布局。4.3布局只在代码块的开始处声明变量（一个块是指任何被包含在｛｝中间的代码）。不要在首次用到该变量时才声明它，这会把注意力不集中的程序员搞湖涂，同时妨碍代码在该作用域内的可移植性。4.4包的声明在多数Java源程序中，第一个非注释行是包语句。packagecn.com.zmanager;4.5类和接口的声明当编写类和接口时，应该遵守以下格式规则：（1）在方法名与其参数列表之前的左括号“（”间不要有空格。（2）左大括号“｛”位于声明语句同行的末尾。（3）右大括号“｝”应另起一行，与相应的声明语句对齐，除非是一个空语句，这种情况下“｝”应紧跟在“｛”之后。（4）方法与方法之间以空行分隔。5、语句规范规范的语句可以改善程序的可读性，让程序员尽快而彻底地理解新的代码。5.1简单语句每行至多包含一条语句。如：argc++;5.2复合语句复合语句是包括在“｛｝”中的语句序列。复合语句遵循如上原则：（1）被括其中的语句应该比复合语句缩进一个层次。（2）左大括号“｛”位于复合语句起始行的末尾。（3）右大括号“｝”应另起一行，并与复合语句首行对齐。（4）大括号可以用于所有语句，包括单个语句，只要这些语句是诸如if-else或for控制结构的一部分。6、注释规范Java程序有两类注释：实现注释（implementationcomment，/*….*/）和文档注释（documentcomment，//）。文档注释可以通过javadoc工具转换成HTML文件，描述Java的类、接口、构造器、方法以及字段（field）。一个注释对应一个类、接口或成员。注释应用来给出代码的总括，并提供代码自身没有提供的附加信息。6.1注释的方法程序可以有四种实现注释的风格：块注释、单行注释、尾端注释和行注释。（1）块注释块注释通常用于提供对文件、方法、数据结构和算法的描述。块注释通常位于每个文件的开始处以及每个方法之前。（2）单行注释如果注释不能在一行内写完，就应该采用块注释。（3）尾端注释极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。（4）行末注释注释界定符“//”可以注释掉整行或者一行的一部分，它一般不用于连续多行的注释文本。注意：（1）频繁的注释有时反映出代码质量低。（2）注释不应写在星号或其符他字符画出来的大框里，不应包括诸如制表符和回退之类的特殊字符。6.2开头注释所有的源文件都应该在开头有一个注释，其中列出文件名、版本信息、日期、作者以及文件描述等。综合管理信息平台采用的头注释统一为：/***文件名：LoginAction.java*author郑伟*版本V1.0*描述：登录操作类*创建时间：201405020上午10：30*文件描述：*修改者：*修改日期：*修改描述：*/6.3类和接口的注释（1）类/接口文档注释（/**……*/）:该注释中包含所需的信息。（2）类/接口实现注释（/*……*/）:如果有必要的话，该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。7、代码范例综合信息管理系统包括登录管理、帐号管理、帐号组权限管理、角色管理、日志管理、统计报表、平台管理、业务信息系统维护等模块。下面以登录管理模块代码、。。。。为例进行描述。一、登录管理模块代码（1）视图层平台登录页面（login.jsp）的代码如下：。。。。。。。。。。。。。（2）控制层登录管理控制层共有1个Action文件和1个ActionForm文件，下面以LoginForm、LoginAction为例描述。①LoginForm代码如下：。。。。。。。。。。。。。②LoginAction代码如下：。。。。。。。。。。。。。（3）模型层登录管理模型层以User.java的部分方法代码如下：。。。。。。。。。。。。（4）运行结果（略）8、目录规范开发环境是Eclipse，开发之后要部署到Tomcat服务器环境上，所以开发环境的目录结构与运行环境的目录结构是一致的，只是在部署的运行环境中，可以不设置源代码的目录。开发目录如图X—XXX所示（略）。各个目录的说明如下：（1）ZManager/src/cn/com/zmanager目录中存放所有的Java公用的模块。（2）ZManager/src/cn/com/zmanager/common目录中存放项目开发所需公共类。。。。。。。。。。。。。