Java变量命名规范


写这个不是给自己的一个备忘,只是最近改了一些前人的BUG,一个大公司,为什么一些基本的编码规范都没有,操蛋了不是,一个类名居然还能写成“BEAN”,一些基本的方法名中文拼音,大小写部分,单词低级拼写错误屡见不鲜,人何以堪啊!抓狂 

下面将一些编码的规范写给那些还走在只求速度上的奋斗程序员

Java是一种区分字母的大小写(case-sensitive)的语言,下面谈谈Java语言中包、类、变量等的命名规范。
(一)Package(包)的命名:Package的名字应该都是由一个小写单词组成,例如net.ebseries.modules。
(二)Class(类)的命名: Class的名字首字母大写,通常由多个单词合成一个类名,要求每个单词的首字母也要大写,例如:DataFile或InfoParser。


(三)变量的命名: 变量的名字可大小写混用,但首字符应小写。词由大写字母分隔,限制用下划线,限制使用美元符号($),因为这个字符对内部类有特殊的含义。如:inputFileSize。

(四) Interface(接口)

的命名:与Class的命名类似。


(五)Static Final 变量(相当于常量)的命名:Static Final 变量的名字应该都大写,并且指出完整含义,例如:final MAXUPLOADFILESIZE=1024。


(六)方法的命名: 方法名的第一个单词应该是动词,大小写可混用,但首字母应小写。在每个方法名内,大写字母将词分隔并限制使用下划线。参数的名字必须和变量的命名规范一致。使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setCounter(int size){
    this.size = size;
}
数组的命名: 数组应该总是用下面的方式来命名:byte[] buffer;而不是:byte buffer[](习惯性问题而已)。
值得注意的是,命名时应尽量采用完整的英文描述符(也有特例)。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。归纳成以下几点,就是:尽量使用完整的英文描述符、采用适用于相关领域的术语、采用大小写混合使名字可读、尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一、避免使用长的名字(小于 15 个字母是个好主意)、避免使用类似的名字,或者仅仅是大小写不同的名字、避免使用下划线(除静态常量等)。

相关内容