失效链接处理 |
Java代码编写规范 PDF 下载
本站整理下载:
相关截图:
![]()
主要内容:
1前言
为了增加可读性,提高代码质量,利于维护。
2命名规范
定义规范的目的是增加可读性,减少时间损耗。
2.1Package 的命名
Package 的名字应该都是由一个小写单词组成。示例:unipost.trans
2.2Class 的命名
Class 的名字每个单词必须由大写字母开头而其他字母都小写的单词组成。示例:FileMng
2.3Class 成员的命名
变量、方法、属性:大小写混排的单词组成,首字母小写
示例: functionName、countNum、size
错误示例:IElementValueService.GetElementValues
2.4Static Final 变量的命名
Static Final常量:大写单词组成,单词之间使用“_”连接
示例:public static final String OLD_PAGE=”1”;
错误示例:public static final String pinyinFieldEndStr="_pinyin_first_let";
2.5数组的命名
数组应该总是用下面的方式来命名:
byte [] buffer;
而不是:
byte buffer [];
2.6方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的属性一样的名字:
setMsg(String msg){
this. msg = msg;
}
2.7缩写
某些通用的缩写可以使用,如:
temp 可缩写为 tmp ;
message 可缩写为 msg ;
2.8标识符命名中应注意的问题
2.8.1除局部循环变量外变量名禁止取单个字符
对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。
2.8.2不用数字定义方法
除非必要,不要用数字或较奇怪的字符来定义标识符。
示例:如下命名,使人产生疑惑。
void set_sls00( BYTE sls );
应改为有意义的单词命名
void setUdtMsgSls( BYTE sls );
|