变量和命名规范.doc

JAVA编程规范变量和命名规范文档编号版 本1.0JAVA编程规范变量规范命名规范1引言本文档对Java代码的编程方式、风格做了统一规范，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。2变量规范2.1 每行个数每一行只允许定义一个变量，不允许定义多个变量。每个变量必须加以注释，换句话说，下面变量定义是正确的int level; / indentation levelint size; / size of table不允许写成如下的变量定义int level, size;不允许在同一行定义不同的变量。例如：int foo, fooarray; /错误的!注: 下面的例子在变量类型和标识符之间用Tab隔开，使得变量的排列比较整齐：intlevel;/ indentation levelintsize;/ size of tableObjectcurrentEntry;/ currently selected table entry2.2 初始化局部变量在定义的同时必须进行初始化。如果无法确认变量的初始值，则置为null。例如：Object currentEntry = null;2.3 定义位置在语句块（被花括弧“”和“”包括的代码段称为语句块）的开始位置定义变量。而不要在首次使用变量时才定义，这样会造成代码混乱和易读性降低。void myMethod() int int1 = 0; / 在方法体开头定义if (condition) int int2 = 0; / 在“if”语句开头定义.有一个特例，对于“for”循环语句的循环变量，可以在“for”循环的条件语句中定义：for (int i = 0; i maxLoops; i+) . 避免局部变量覆盖外部变量。例如，不要在内部语句块定义和外部变量同名的变量：int count;.myMethod() if (condition) int count; / 避免!.2.4 类和接口的定义当编写Java类或接口定义时，下列规则必须遵守：l 方法名称和其参数列表前的圆括弧“(“之间不允许有空格l 开括弧“”必须在定义语句之后的同一行，作为定义语句的一部分l 闭括弧“”必须单独一行，位置和类或接口定义语句左对齐。有一种特殊情况，当“”和“”之间没有任何语句时，“”必须紧跟在“”之后class Sample extends Object int ivar1;int ivar2;Sample(int i, int j) ivar1 = i;ivar2 = j;int emptyMethod() .l 方法之间必须以空行分隔3命名规范3.1 功能命名处理功能 组件缩写处理内容缩写控件类Add追加处理btnButton类Allok确认处理chbCheckBox类Back备份处理cbgCheckboxGroup类Clc计算处理cboComboBox类Chg更改处理choChoice类Check检查处理lblLabel类Close关闭处理lstList类Clear清空处理txtTextField类Cmp比较处理txtTextArea类Cnv转换处理cnvCanvas类Copy复制处理dlgDialog类Create生成处理pnlPanel类Delete删除处理mnuMenuItem类Disp显示处理stsStatusBar类End结束处理frmFrame类Err错误处理Free释放处理Get取得处理Lock锁定处理Ini初始化处理Ins插入处理Make作成处理Mdi编辑(修改)处理Move移动处理MsgMessage处理OpenOpen处理Print印刷处理Read读入处理Req要求处理Serch检索处理Set设定处理Upd更新处理Write写入处理 对处理功能的缩写，具体使用时还应遵从被使用的对象的命名规范 对组件缩写，要写1 个大写字母和全部的小写字母，遵从具体被使用的对象的命名规范，最好执行1 个字母的大写/小写。例： TextField txtPassword （变量）3.2 对象命名3.2.1 Package的命名Package的名字应该是全部由小写字母组成。原则上按照其完成的业务功能进行命名，要求系统需求开发时就要划分业务模块。3.2.2 文件名规范JAVA源程序的文件名必须和其包含的public类名称一致，诸如（class名）java。3.2.3 Class的命名要求遵循以下规范：l 若Class的名字是一个单名词，必须开头字母大写而其它字母都小写例： Streeml 若Class的名字是复合名词，必须每个组成单词的开头大写而其它字母都小写例： InputStreeml 使用他人易懂的class名，尽可能想像的实物描述例： ByteArrayInputStreem3.2.4 interface的命名（与class名的命名规则相同）3.2.5 method的命名要求遵循以下规范：l 有复合单词时，开始的单词用小写字母开头，从第2单词起用大写的字母作开始的单词。例： toStringl 只有动词时，全部用小写。例： read，skipl 用表示method的动作的描述。l gettersetter method，set“用大写字母开头的变量名”，get“用大写字母开始的变量名”例： getName，setLength3.2.6 变量的命名变量名（member名（field名）、临时变量名）要求遵循以下规范：l 变量的名字必须用一个小写字母开始的词，后面的单词用大写字母开头例： bufferSizel 1个字母的变量要用以下被许可了的变量名byte bchar cdouble dException efloat f整数 i,j,klong lObject oString sl Static Final变量的名字应该都大写，并且指出完整含义l 变量名尽可能简短明了3.2.7 参数的命名要求遵循以下规范：l 参数的命名和变量的命名规范一致l 参数名称使用和要赋值的字段一样的名字SetCounter(int size)this.size = size;3.2.8 数组的命名数组应该总是用下面的方式来命名：byte buffer;而不是：byte buffer;3