爛代碼吐槽匯 | 奇葩命名

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


1.奇葩項目(模塊)名

項目(模塊)名稱使用漢語拼音、英漢雙拼、超長的字母集。

項目(模塊)名稱應該使用言簡意賅的英文單詞或短語,可代表項目(模塊)意圖即可。

2.奇葩包名

包名稱使用毫無意義的單個字母或另類的單詞。

正常的包結構名稱應該以官網或產品域名的倒序為基礎包,然后細分service、dao等。基本上常用的包名也就那幾個,沒必要為了體現出自己的不同而新創包名,如果真的有必要建新包名,應該使用名詞性質的單詞。

3.奇葩接口名

接口名命名規則不統一,千奇百怪,使用非名詞性單詞。

一般情況下,根據團隊編碼習慣,接口名稱規則需要統一。最好不要使用以字母I為前綴或以interface為后綴,你不覺得這樣很多此一舉嗎?名稱命名需要使用名詞性的單詞或短語。

4.奇葩類名和對象名

類名或對象名使用動詞,使用非名詞或非名詞短語。

類名和對象名是一個標識,所以不要使用動詞,應該使用名詞或名詞性的短語,而且最好不要使用以Data和Info為后綴,這樣的后綴給人感覺很累贅。

5.奇葩屬性名

類的屬性名為了和表的字段名稱一致,名稱中的單詞使用下劃線連接;屬性名使用非駝峰式命名;使用無意義的字母或單詞縮寫。

類的屬性名應該使用有意義的名詞或名詞性的短語,名稱的首字母要小寫,名稱中包含多個單詞的需要使用駝峰式的命名規則,一定不要使用無明確意義的字母或單詞縮寫。如果為了表達多個數據的集合,避免使用List結尾,可以使用對應單詞的復數形式,如students,而不是studentList。推薦使用一些可讀的出來或可搜索到的單詞或短語,易于理解。對于一些boolean類型的屬性名,推薦在名稱前加上is前綴,這樣容易理解其值的含義。

6.奇葩方法名

方法名以非動詞開頭;方法名不能表達出方法體的意圖;方法名使用以get為前綴;方法名使用單詞或短語的字母縮寫;方法名不遵循駝峰式命名規則。

方法名應該以動詞開頭,使用動詞短語;動詞短語應該可以表達出本方法體的意圖,做到可以根據方法名看出方法做了什么;除了屬性的getter方法,避免使用以get作為方法名的前綴,因為get無法說清方法的意圖,有偷懶的嫌疑,而且這樣命名說明寫代碼的人真的很low;最不能忍的是方法名使用單詞的字母縮寫,誰能知道這是干啥的,就是代碼作者自己,一段時間后也不能保證記得這是作什么的;方法名應該遵循首字母小寫的駝峰式命名規則;對于返回值類型為布爾值類型的方法,推薦方法名前綴使用is、has、can。

7.奇葩變量名

變量名使用單個字母。

除了用于循環的臨時變量名,其它變量都不要使用單個字母命名,且變量名要能表達出其真正意圖,遵循駝峰式命名規則。

8.奇葩常量名

常量名使用非大寫的單詞或短語;常量名中的多個單詞間不使用下劃線連接。

常量名應該全部使用大寫的字母,而且單詞與單詞間使用下劃線連接。對于方法里用于比較或計算的“0”、“1”之類的常量,最好定義成常量,使用常量名標識這些數據的意思,否則誰能理解“0”代表什么,“1”代表什么。

小結

命名可以通過總結的方式,歸納出屬于自己的一套命名規則。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,818評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,185評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,656評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,647評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,446評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,951評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,041評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,189評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,718評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,800評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,419評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,420評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,755評論 2 371

推薦閱讀更多精彩內容

  • 1、引言 數據庫設計過程中表、字段等的命名規范也算是設計規范的一部分,不過設計規范更多的是為了確保數據庫設計的合理...
    SnowflakeCloud閱讀 41,046評論 0 48
  • 1.Resource文件 命名 遵循前綴表明類型的習慣,形如type_foo_bar.xml。如:fragment...
    Rave_Tian閱讀 4,407評論 0 1
  • Android編碼規范 源文件基礎 文件名 源文件以其最頂層的類名來命名,大小寫敏感,文件擴展名為.java。 文...
    呼呼哥閱讀 968評論 0 0
  • [TOC] 前言 這份文檔是Google Java編程風格規范的完整定義。當且僅當一個Java源文件符合此文檔中的...
    marine8888閱讀 1,954評論 0 1
  • Cocoa代碼風格指南之命名規范(一) Cocoa代碼風格指南之排版規范(二) Cocoa代碼風格指南之注釋規范(...
    xuyafei86閱讀 3,413評論 0 8