爛代碼吐槽匯 | 奇葩命名

代碼首先是給人看的蜕衡,其次才是給機器看的壤短。 爛代碼特征:可讀性差、邏輯混亂、性能低下久脯。


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ī)則。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末噩茄,一起剝皮案震驚了整個濱河市下面,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌绩聘,老刑警劉巖诸狭,帶你破解...
    沈念sama閱讀 221,888評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異君纫,居然都是意外死亡驯遇,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,677評論 3 399
  • 文/潘曉璐 我一進店門蓄髓,熙熙樓的掌柜王于貴愁眉苦臉地迎上來叉庐,“玉大人,你說我怎么就攤上這事会喝《傅” “怎么了?”我有些...
    開封第一講書人閱讀 168,386評論 0 360
  • 文/不壞的土叔 我叫張陵肢执,是天一觀的道長枉阵。 經(jīng)常有香客問我,道長预茄,這世上最難降的妖魔是什么兴溜? 我笑而不...
    開封第一講書人閱讀 59,726評論 1 297
  • 正文 為了忘掉前任,我火速辦了婚禮耻陕,結(jié)果婚禮上拙徽,老公的妹妹穿的比我還像新娘。我一直安慰自己诗宣,他們只是感情好膘怕,可當我...
    茶點故事閱讀 68,729評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著召庞,像睡著了一般岛心。 火紅的嫁衣襯著肌膚如雪来破。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,337評論 1 310
  • 那天忘古,我揣著相機與錄音徘禁,去河邊找鬼。 笑死存皂,一個胖子當著我的面吹牛晌坤,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播旦袋,決...
    沈念sama閱讀 40,902評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼骤菠,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了疤孕?” 一聲冷哼從身側(cè)響起商乎,我...
    開封第一講書人閱讀 39,807評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎祭阀,沒想到半個月后鹉戚,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,349評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡专控,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,439評論 3 340
  • 正文 我和宋清朗相戀三年抹凳,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片伦腐。...
    茶點故事閱讀 40,567評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡赢底,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出柏蘑,到底是詐尸還是另有隱情幸冻,我是刑警寧澤,帶...
    沈念sama閱讀 36,242評論 5 350
  • 正文 年R本政府宣布咳焚,位于F島的核電站洽损,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏革半。R本人自食惡果不足惜碑定,卻給世界環(huán)境...
    茶點故事閱讀 41,933評論 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望督惰。 院中可真熱鬧不傅,春花似錦、人聲如沸赏胚。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,420評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽觉阅。三九已至崖疤,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間典勇,已是汗流浹背劫哼。 一陣腳步聲響...
    開封第一講書人閱讀 33,531評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留割笙,地道東北人权烧。 一個月前我還...
    沈念sama閱讀 48,995評論 3 377
  • 正文 我出身青樓,卻偏偏與公主長得像伤溉,于是被迫代替她去往敵國和親般码。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,585評論 2 359

推薦閱讀更多精彩內(nèi)容