代碼首先是給人看的蜕衡,其次才是給機器看的壤短。 爛代碼特征:可讀性差、邏輯混亂、性能低下久脯。
1.奇葩項目(模塊)名
項目(模塊)名稱使用漢語拼音纳胧、英漢雙拼、超長的字母集帘撰。
項目(模塊)名稱應該使用言簡意賅的英文單詞或短語跑慕,可代表項目(模塊)意圖即可。
2.奇葩包名
包名稱使用毫無意義的單個字母或另類的單詞摧找。
正常的包結(jié)構(gòu)名稱應該以官網(wǎng)或產(chǎn)品域名的倒序為基礎包相赁,然后細分service、dao等慰于∨タ疲基本上常用的包名也就那幾個,沒必要為了體現(xiàn)出自己的不同而新創(chuàng)包名婆赠,如果真的有必要建新包名绵脯,應該使用名詞性質(zhì)的單詞。
3.奇葩接口名
接口名命名規(guī)則不統(tǒng)一休里,千奇百怪蛆挫,使用非名詞性單詞。
一般情況下妙黍,根據(jù)團隊編碼習慣悴侵,接口名稱規(guī)則需要統(tǒng)一。最好不要使用以字母I為前綴或以interface為后綴拭嫁,你不覺得這樣很多此一舉嗎可免?名稱命名需要使用名詞性的單詞或短語。
4.奇葩類名和對象名
類名或?qū)ο竺褂脛釉~做粤,使用非名詞或非名詞短語浇借。
類名和對象名是一個標識,所以不要使用動詞怕品,應該使用名詞或名詞性的短語妇垢,而且最好不要使用以Data和Info為后綴,這樣的后綴給人感覺很累贅肉康。
5.奇葩屬性名
類的屬性名為了和表的字段名稱一致闯估,名稱中的單詞使用下劃線連接;屬性名使用非駝峰式命名吼和;使用無意義的字母或單詞縮寫涨薪。
類的屬性名應該使用有意義的名詞或名詞性的短語,名稱的首字母要小寫纹安,名稱中包含多個單詞的需要使用駝峰式的命名規(guī)則尤辱,一定不要使用無明確意義的字母或單詞縮寫砂豌。如果為了表達多個數(shù)據(jù)的集合,避免使用List結(jié)尾光督,可以使用對應單詞的復數(shù)形式阳距,如students,而不是studentList结借。推薦使用一些可讀的出來或可搜索到的單詞或短語筐摘,易于理解。對于一些boolean類型的屬性名船老,推薦在名稱前加上is前綴咖熟,這樣容易理解其值的含義。
6.奇葩方法名
方法名以非動詞開頭柳畔;方法名不能表達出方法體的意圖馍管;方法名使用以get為前綴;方法名使用單詞或短語的字母縮寫薪韩;方法名不遵循駝峰式命名規(guī)則确沸。
方法名應該以動詞開頭,使用動詞短語俘陷;動詞短語應該可以表達出本方法體的意圖罗捎,做到可以根據(jù)方法名看出方法做了什么骗露;除了屬性的getter方法蛤克,避免使用以get作為方法名的前綴享怀,因為get無法說清方法的意圖蔼卡,有偷懶的嫌疑,而且這樣命名說明寫代碼的人真的很low鸦做;最不能忍的是方法名使用單詞的字母縮寫立叛,誰能知道這是干啥的厨幻,就是代碼作者自己告私,一段時間后也不能保證記得這是作什么的屎暇;方法名應該遵循首字母小寫的駝峰式命名規(guī)則;對于返回值類型為布爾值類型的方法驻粟,推薦方法名前綴使用is、has凶异、can蜀撑。
7.奇葩變量名
變量名使用單個字母。
除了用于循環(huán)的臨時變量名剩彬,其它變量都不要使用單個字母命名酷麦,且變量名要能表達出其真正意圖,遵循駝峰式命名規(guī)則喉恋。
8.奇葩常量名
常量名使用非大寫的單詞或短語沃饶;常量名中的多個單詞間不使用下劃線連接母廷。
常量名應該全部使用大寫的字母,而且單詞與單詞間使用下劃線連接糊肤。對于方法里用于比較或計算的“0”琴昆、“1”之類的常量,最好定義成常量馆揉,使用常量名標識這些數(shù)據(jù)的意思业舍,否則誰能理解“0”代表什么,“1”代表什么升酣。
小結(jié)
命名可以通過總結(jié)的方式舷暮,歸納出屬于自己的一套命名規(guī)則。