java项目开发规范_第1页
java项目开发规范_第2页
java项目开发规范_第3页
java项目开发规范_第4页
java项目开发规范_第5页
已阅读5页,还剩1页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

项目开发规范:开发人员分工:每人负责一个模块的开发,由后端一直到前端。实现所有功能。每个人每天必须写出项目进度总结。数据库管理所有数据表格必须一致。也就是保持数据的一致性。必须遵循命名规范。能重用的类应尽可能的使用。遵守以下代码规范:JAVA程序编写规范1.1命名规则1.1.1文件的命名规则 请参考各模块相关设计文档。1.1.2变量的命名规则变量的格式:变量的前缀+变量描述变量前缀数据类型前缀标记Char/signedcharchChar[]cUnsignedcharuchShort[int]/signedshort[int]siUnsignedshort[int]usiInt/signed[int]/Int[]iUnsigned[int]uiLong[int]/signedlong[int]liUnsignedlong[int]uliFloatfDoubledLongdoubleldEnumenu*pStructuresctUnionunnStringszString[]sHashtablehHashtable[]hbVectorvbooleanb其它数组arr_对象结合对象名各英文单词首字母的缩写变量描述的第一个字符必须大写,与前缀区分开,前缀必须小写。数组变量的定义格式,要把数组的前缀放在前面,格式如下:数组前缀+变量的前缀+描述如:NodeList[]arrNLTemp[3]表示节点列表数组。变量的定义,必须在程序的首部或函数的首部,不允许任意定义变量。变量必须在定义时初始化。变量表达尽量使用英文单词全称,每一单词首字母使用大写。1.1.3常量的命名规则全部使用大写的字母,不需要前缀,但是每一描述名用下划线隔开。如:privatefinalintTRACE_FILE_NAME=123451.1.4函数的命名规则建议函数名称用体现功能的英文单词组成(可以是缩写的组合),第一个单词的首字母必须小写,后面的每一个单词的首字母必须大写。如:setMsg,removeMsg。总之,对于常量、变量和函数等标识符的命名,应该做到“见名知意”,即选有含义的英文单词(或缩写)标识符。除数值运算程序外,不要用代数符号(如:a,b等),以增加程序的可读性。1.2注释1.2.1需要注释地方程序文件的首部。方法定义之前。程序的关键地方。每个主要结构处。如:if结构,while结构,switch结构,及结构内的关键语句处。每个变量说明语句。空出来准备将来添加代码的地方。每个特殊的或容易引起误解地方。1.2.2注释编写规范注释符号“/***/”,“/**/”or“//”,注释语句于注释符号之间要有1个或1个以上的空格。如:/**Thisisthecomment*//*Thisisthecomment*///Thisisthecomment.如果注释单独起一行,被注释的语句是紧跟其后的语句,单起一行的注释要与被注释的语句垂直对齐,被注释的语句不能与注释语句之间有空行,注释要与前面的语句有个空行。单独起行的注释使用“//“。多行注释使用“/**/”。格式说明:1.3.3缩进缩进是指与上一条语句相比向右推进4个空格(注意不要使用TAB)。被派生出来的语句需要缩进。例如:for(inti=0;i<10;i++){语句1;语句2;}有派生关系的语句还有:if语句,函数头与主体,循环条件与循环体,结构体的定义语句与结构体变量说明语句。当一条语句需要换行时,下一行相对需要缩进。1.3.4缩进与对齐的例子:/***commentline1*commentline2*commentline3*/importjava.io.*;importjava.util.*;publicclassHelloWorldApp{inta=1;//commentline/***functionname:printString()*statement:*@param int iTemp processflag*@return void*Note:inputparameteriTempcannotbenull.*/privatevoidprintString(intiTemp){语句1;语句2;…}}1.4花括号花括号一般要另起一行,下列情况例外。数组初始化,例如:int[]arrant={1,2,3};另起一行的花括号要符合对齐规范。1.5空行、空格空行只容许一行。必须空行的地

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论