2008年6月3日 星期二

Java命名慣例

蔡煥麟先生在http://blog.blueshop.com.tw/omusico/   有很精彩的整理,節錄如下

通用慣例

使用完整的、能夠望文生義的英文。
使用跟該領域相關的術語。
大小寫混合使用,以增加可讀性。
名稱盡量不要超過15個字元。
不要只用大小寫的差異來辨別兩個變數名稱,這樣容易造成混淆。

項目命名慣例範例

Parameters
參數使用完整的英文來描述傳遞的變數/物件,可以在前面冠上'a'或'an',不管用哪種方式,最重要的是定下來以後就要遵守它。customer,account或 aCustomer,anAccount

Fields/properties
欄位/屬性?使用完整的英文,第一個單字(word)的第一個字母小寫,其餘的單字的第一個字母大寫。firstName,lastName
傳回布林型態的getter成員函式開頭一律冠上'is'。isDead,isString,isFailed

Classes
類別使用完整的英文,類別名稱的每個單字的第一個字母大寫,其餘字母為小寫。Customer,SavingAccount

Exceptions
異常通常以小寫字母'e'代表異常物件。e

Finalstaticfields(consants)
常數全部使用大寫英文字母,每個單字以底線分隔。MIN_BALANCE,
DEFAULT_DATE

Localvariables
區域變數使用完整的英文,第一個單字(word)的第一個字母小寫,其餘的單字的第一個字母大寫。注意:應避免和類別的欄位名稱相同,以免產生混淆,例如,你有一個欄位名稱是'firstName',那麼在成員函式中的區域變數就不要取相同的名稱。grandTotal,customer,newAccount

Loopcounters
迴圈計數器通常以'i','j','k'或'counter'來命名。i,j,k,cnt,counter

Memberfunctions
成員函式使用完整的英文,第一個單字(word)的第一個字母小寫,其餘的單字的第一個字母大寫,盡可能以動詞開頭。openFile(), addAccount()
Setter成員函式把要存取的欄位名稱前面冠上'set'。setFirstName(),
setLastName()


區域變數的命名可以稍有彈性,對於比較不重要的變數,可以採取下列簡短的命名方式,但請特別注意,不可濫用,原則上仍應該盡量以完整的英文來命名:
變數類型建議的命名慣例
offsetoff
lengthlen
charc或ch
floatf
Objecto或obj
Strings或str

資料來源:http://blog.blueshop.com.tw/omusico/

沒有留言: