java项目开发规范标准[详].doc

《java项目开发规范标准[详].doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

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

2、int]/signedshort[int]siUnsignedshort[int]usiInt/signed[int]/Int[]iUnsigned[int]uiLong[int]/signedlong[int]liUnsignedlong[int]uliFloatfDoubledLongdoubleldEnumenu*pStructuresctUnionunnStringszString[]sHashtablehHashtable[]hbVectorv........booleanb其它数组arr_对象结

3、合对象名各英文单词首字母的缩写1)变量描述的第一个字符必须大写，与前缀区分开，前缀必须小写。2)数组变量的定义格式，要把数组的前缀放在前面，格式如下：数组前缀+变量的前缀+描述如：NodeList[]arrNLTemp[3]表示节点列表数组。3)变量的定义，必须在程序的首部或函数的首部，不允许任意定义变量。4)变量必须在定义时初始化。5)变量表达尽量使用英文单词全称，每一单词首字母使用大写。1.1.3常量的命名规则全部使用大写的字母，不需要前缀,但是每一描述名用下划线隔开。如：privatefinalint

4、TRACE_FILE_NAME=123451.1.4函数的命名规则建议函数名称用体现功能的英文单词组成（可以是缩写的组合），第一个单词的首字母必须小写，后面的每一个单词的首字母必须大写。如：setMsg,removeMsg。总之，对于常量、变量和函数等标识符的命名，应该做到“见名知意”，即选有含义的英文单词（或缩写）标识符。除数值运算程序外，不要用代数符号（如：a,b等），以增加程序的可读性。1.2注释1.2.1需要注释地方Ø程序文件的首部。Ø方法定义之前。Ø程序的关键地方。Ø每个主要结构处。如：if结构，

5、while结构，switch结构，及结构的关键语句处。Ø每个变量说明语句。Ø空出来准备将来添加代码的地方。Ø每个特殊的或容易引起误解地方。1.2.2注释编写规Ø注释符号“/***/”,“/**/”or“//”，注释语句于注释符号之间要有1个或1个以上的空格。如：u/**Thisisthecomment*/u/*Thisisthecomment*/u//Thisisthecomment.Ø如果注释单独起一行，被注释的语句是紧跟其后的语句，单起一行的注释要与被注释的语句垂直对齐，被注释的语句不能与注释语句之间有

6、空行，注释要与前面的语句有个空行。单独起行的注释使用“//“。多行注释使用“/**/”。格式说明：........A．上、下、左边框与注释语句首部垂直对齐。B．左边框的第一行用符号“/*”，最后一行用“*/”，其他行用符号“*”左边框所有“*”必须垂直对齐。C．注释语句上下各有一空行。D．注释语句与“*”之间要间隔1个空格。Ø程序某一语句之后的注释，要与语句本身之间保留4个空格的位置(注意不要用TAB)，原则是尽量容易区分开程序的语句与注释。如：语句1/*thisisthecomment*/语句2//thi

7、sisthecomment.Ø函数的注释关于方法定义的注释格式如下：/***functionname：*statement：*param*return*exception*callfunction*Note*/格式说明：a.注释语句的上下左边框必须对齐。b.注释语句(除第一行少一个空格)与上边框各保留一个空行。例如：/***functionname：KillComma()*statement：去掉字符串中的“，”*paramchar[]arr_cTemp传入字符串*returnchar[]arr_cA*No

8、te：字符串不能为空。*/Ø程序文件的注释对每一个程序文件，在文件头部必须有注释，注释符号的形式与方法的注释符号的形式相同，注释语句必须包括如下：/***Project:*Filename:*Description:*Methods:*Author:*Date:*--------------------------------------------------------------------*Modify1