寫這個不是給自己的一個備忘,只是最近改了一些前人的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 個字母是個好主意)、避免使用類似的名字,或者僅僅是大小寫不同的名字、避免使用下劃線(除靜態常量等)。