说明:指对编码中出现的名字进行命名。难懂的代码,显然也很难分析和改造。因此而造成单纯错误的几率大增,调试也极费时间。代码变得难懂,其中一个重要原因就是变量名和方法名不好懂。比如,堆砌一些没有任何涵义的符号或者其含义和名字不一致自不必说,就算是英语的拼写错了,也会使代码变得难懂,更容易发生误解。
仅仅是把命名进行统一,就可以大大提高代码的可读性。通过使用简明易懂的名字,不仅仅是使别人的代码可读性提高,就是自己的代码,回过头来读的时候,各种变量,方法的作用极其明确,可以很容易地把握处理的内容。从而大大提高代码的可维护性,大大提高生产性。
修正例:Public static final int MAX = 10; //OK;
Public static final int min = 0; //ERROR:常量应该大写
Public void func(void) {
int a0001; //ERROR:符号罗列,含义不明
int priolity; //ERROR:英语拼写错误
int number; //OK;
int Number; //ERROR:大小写混杂,而且头文字为大写
…
} 在Java语言中,Sun的命名规约已经浸透到开发的所有领域,各种类库以及支持工具大多是以Sun的命名规约作为前提的。建议尽可能地遵从Sun的命名规约。
补充说明 在命名中应该规定的项目
为了统一命名,建议将下列项目作为命名规约的内容。另外,命名规约一定要好用,容易遵守。
• 对命名的全面的指针
• 文件名(含目录名)的命名规则
• 包,类,方法,变量,常量的命名规则 等。
对命名的全面指针是指
• 大小写的使用,以及标记的统一
• 禁止记号和序号的简单罗列,要求所有名字都有明确含义
• 不使用省略形式
• 作用不同则名字不同
• 成员变量和局部变量不使用相同的名称等等。代表性的命名规约请参阅参考文献。
Sun推荐的命名规约(概要)
• 包名必须都是小写字
com.sun.eERROR; com.apple.quicktime.v2• 类/接口名必须是名词,各单词的第一个字是大写
class Raster; class ImageSprite;
• 方法名必须是动词,第一个字是小写字,但后面的单词的第一个字是大写
run(); runFast(); getBackground();
• 变量的第一个字是小写字,但后面的单词的第一个字是大写
char c; float myWidth;
• 常量用大写字,各单词之间用下杠“_”分隔
static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999:
第7条 使用了魔法数值