项目开发规范

1、项目开发规范：1、 开发人员分工：每人负责一个模块的开发，由后端一直到前端。实现所有功能。2、 每个人每天必须写出项目进度总结。3、 数据库管理所有数据表格必须一致。也就是保持数据的一致性。4、 必须遵循命名规范。能重用的类应尽可能的使用。5、 遵守以下代码规范：1. JAVA 程序编写规范1.1命名规则 文件的命名规则请参考各模块相关设计文档。变量的命名规则变量的格式：变量的前缀+变量描述变量前缀数据类型前缀标记Char / signed charchCharcUnsigned charuchShort int / signed short intsiUnsigned short intus

2、iInt / signed int / IntiUnsigned intuiLong int / signed long intliUnsigned long intuliFloatfDoubledLong doubleldEnum enu*pStructuresctUnionunnStringszStringsHashtablehHashtablehbVectorvbooleanb其它数组arr_对象结合对象名各英文单词首字母的缩写1) 变量描述的第一个字符必须大写，与前缀区分开，前缀必须小写。2) 数组变量的定义格式，要把数组的前缀放在前面，格式如下：数组前缀+变量的前缀+描述如：Node

3、List arrNLTemp3 表示节点列表数组。3) 变量的定义，必须在程序的首部或函数的首部，不允许任意定义变量。4) 变量必须在定义时初始化。5) 变量表达尽量使用英文单词全称，每一单词首字母使用大写。常量的命名规则全部使用大写的字母，不需要前缀,但是每一描述名用下划线隔开。如：private final int TRACE_FILE_NAME=12345 函数的命名规则建议函数名称用体现功能的英文单词组成（可以是缩写的组合），第一个单词的首字母必须小写， 后面的每一个单词的首字母必须大写。如：setMsg, removeMsg。总之，对于常量、变量和函数等标识符的命名，应该做到“见名知

4、意”，即选有含义的英文单词（或缩写）标识符。除数值运算程序外，不要用代数符号（如：a,b等），以增加程序的可读性。1.2注释需要注释地方Ø 程序文件的首部。Ø 方法定义之前。Ø 程序的关键地方。Ø 每个主要结构处。如：if 结构，while结构，switch结构，及结构内的关键语句处。Ø 每个变量说明语句。Ø 空出来准备将来添加代码的地方。Ø 每个特殊的或容易引起误解地方。注释编写规范Ø 注释符号“/* */”,“/* */”or “/ ”，注释语句于注释符号之间要有1个或 1个以上的空格。如：u /* This

5、is the comment */u /* This is the comment */u / This is the comment.Ø 如果注释单独起一行，被注释的语句是紧跟其后的语句，单起一行的注释要与被注释的语句垂直对齐，被注释的语句不能与注释语句之间有空行，注释要与前面的语句有个空行。单独起行的注释使用“/“。多行注释使用“/* */”。格式说明：A上、下、左边框与注释语句首部垂直对齐。B左边框的第一行用符号“/*”，最后一行用“*/”，其他行用符号“*”左边框所有“*”必须垂直对齐。C注释语句上下各有一空行。D注释语句与“*”之间要间隔1个空格。Ø 程序某一语句

6、之后的注释，要与语句本身之间保留4个空格的位置(注意不要用TAB)，原则是尽量容易区分开程序的语句与注释。如： 语句1 /* this is the comment */ 语句2 / this is the comment.Ø 函数的注释关于方法定义的注释格式如下：/* function name：* statement：* param* return* exception * call function * Note*/格式说明：a.注释语句的上下左边框必须对齐。b.注释语句(除第一行少一个空格)与上边框各保留一个空行。例如：/* function name：KillComma (

7、)* statement：去掉字符串中的“，”* param char arr_cTemp 传入字符串* return char arr_cA * Note： 字符串不能为空。*/Ø 程序文件的注释对每一个程序文件，在文件头部必须有注释，注释符号的形式与方法的注释符号的形式相同，注释语句必须包括如下：/* Project:* Filename: * Description:* Methods: * Author:* Date: * -* Modify 1* UpdateBy:* Update Date:* Update Description:* -* Modify 2* Updat

8、eBy:* Update Date:* Update Description:*/Filename文件名称Description本程序的描述（功能、作用与之相关的程序等）Project所属项目Methods列出在本程序文件中定义的方法及简要说明Author程序的编写者Date程序完成的日期 格式：yyyy-mm-ddModify 1第一次修改UpdateBy修改者UpdateTime修改日期 格式：yyyy-mm-ddUpd.Description修改说明（指明修改了什么地方，修改原因等）1.3行宽、缩进与对齐行宽为了程序在屏幕中不需要通过滑动条就能更好把程序的语句看到。程序每行的宽度不得超过

9、100个字符，超过100个字符必须折行显示。注意：如果语句需要换行，换行的位置要合适，一般在逗号，算术符号等处，不要在变量的中间换行。同一行不要写2条或2条以上的语句。例如：If (req.getParameter (“submit”)! =null && ! Ret.getParameter (“submit”). Equals (“”) 语句1； 语句2；对齐Ø 对齐是指垂直左对齐。Ø 函数的定义与函数的注释，必须顶头写。Ø 同一层次的相对语句必须对齐。（例如：函数，操作语句，结构体定义等）。Ø 在不同行的左花括号“”和与相对应的右花

10、括号“”必须对齐。Ø 单独起行的注释与被注释语句对齐。缩进Ø 缩进是指与上一条语句相比向右推进4个空格（注意不要使用TAB）。Ø 被派生出来的语句需要缩进。例如：for (int i=0;i<10;i+)语句1；语句2；Ø 有派生关系的语句还有：if语句，函数头与主体，循环条件与循环体，结构体的定义语句与结构体变量说明语句。Ø 当一条语句需要换行时，下一行相对需要缩进。缩进与对齐的例子：/* comment line1 * comment line2 * comment line3 */import java.io.*;import java.util.*;public class HelloWorldApp int a=1; / comment line /* function name：printString ()* statement：* paramintiTempprocess flag * returnvoid* Note: input parameter iTemp can not be null.*/private void printString (int iTemp) 语句1； 语句2； 1.4花括号花括号一般要另起一行，下列情况例外。数组初