变量及命名规范.doc

文档编号 版 本 1.0 JAVA编程规范 变量规范 命名规范 1．引言 本文档对Java代码的编程方式、风格做了统一规范，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。 本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。 2．变量规范 2.1 每行个数 每一行只允许定义一个变量，不允许定义多个变量。每个变量必须加以注释，换句话说，下面变量定义是正确的 int level; // indentation level int size; // size of table 不允许写成如下的变量定义 int level, size; 不允许在同一行定义不同的变量。例如： int foo, fooarray[]; //错误的! 注: 下面的例子在变量类型和标识符之间用Tab隔开，使得变量的排列比较整齐： int level; // indentation level int size; // size of table Object currentEntry; // currently selected table entry 2.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类或接口定义时，下列规则必须遵守： 方法名称和其参数列表前的圆括弧“(“之间不允许有空格 开括弧“{”必须在定义语句之后的同一行，作为定义语句的一部分 闭括弧“}”必须单独一行，位置和类或接口定义语句左对齐。有一种特殊情况，当“{”和“}”之间没有任何语句时，“}”必须紧跟在“{”之后 class Sample extends Object { int ivar1; int ivar2; Sample(int i, int j) { ivar1 = i; ivar2 = j; } int emptyMethod() {} ... } 方法之间必须以空行分隔 3．命名规范 3.1 功能命名 ［处理功能］ ［ＧＵＩ组件］ 缩写 处理内容 缩写 控件类 Add 追加处理 btn Button类 Allok 确认处理 chb CheckBox类 Back 备份处理 cbg CheckboxGroup类 Clc 计算处理 cbo ComboBox类 Chg 更改处理 cho Choice类 Check 检查处理 lbl Label类 Close 关闭处理 lst List类 Clear 清空处理 txt TextField类 Cmp 比较处理 txt TextArea类 Cnv 转换处理 cnv Canvas类 Copy 复制处理 dlg Dialog类 Create 生成处理 pnl Panel类 Delete 删除处理 mnu MenuItem类 Disp 显示处理 sts StatusBar类 End 结束处理 frm Frame类 Err 错误处理 Free 释放处理 Get 取得处理 Lock 锁定处理 Ini 初始化处理 Ins 插入处理 Make 作成处理 Mdi 编辑(修改)处理 Move 移动处理 Msg Message处理 Open Open处理 Print 印刷处理 Read 读入处理 Req 要求处理 Serch 检索处理 Set 设定处理 Upd 更新处理 Write 写入处理 对处理功能的缩写，具