簡潔代碼--命名

代碼整潔之道筆記

[TOC]

命名

代碼的整潔,從命名開始

名副其實焕毫、準確

名稱應該能夠說明該(變量铣墨、類弟灼、函數(shù))存在的意義:

int d;  //無法體現(xiàn)出該變量的用途
int daysSinceCreation;
int elapsedTimeInDays;

準確的命名能夠清晰的說明代碼的意圖:

public List<int[]> getFlaggedCells() {
    List<int[]> list1 = new ArrayList<int[]>();
    for (int[] x: theList)
        if (x[0] == 4)
            list1.add(x);

    return list1;
}

public List<Cell> getFlaggedCells() {
    List<Cell> flaggedCells = new ArrayList<int[]>();
    for (Cell cell: gameBoard)
        if (Cell.isFlagged())
            flaggedCells.add(cell);

    return flaggedCells;
}

避免誤導

少用專有名詞:

int accountLists | int accountGroup | int accounts;
顯然List會讓人想到List數(shù)據類型,需要改用另外兩個更好的選擇徙缴。

有意義的區(qū)分

如用info寂屏、data這樣的詞修飾的命名意義含混。
動詞不應該出現(xiàn)在變量名中娜搂。table不應該出現(xiàn)在表名中:

nameString     ===> name
CustomerObject ===> Customer
moneyAmount    ===> money
customerData   ===> customer

可閱讀的名字

簡單來說就是別自己瞎造詞迁霎,選通用一點的單詞。

類名

不應該是動詞百宇,不應該是語意含混詞(data考廉、info、manager携御、processor)

方法名

應該是動詞或者動詞短語昌粤。

getXXX();
setXXX();
deletePage();

概念單一對應

如插入數(shù)據方法用add或create,編輯用edit或update啄刹。
如控制不要同時出現(xiàn)controller涮坐、manager或

添加有意義的語境

有時候命名的方法變量不能清晰的表明意圖,這個時候可以將方法放在類中誓军,提供更明確的語境:

public class GuessStatisticsMessage {
    private String number;
    private String verb;

    public String make() {

    }
}

最關鍵的是

一定要學好英語啊~~~~~~~~ QAQ

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末袱讹,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子昵时,更是在濱河造成了極大的恐慌捷雕,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件壹甥,死亡現(xiàn)場離奇詭異救巷,居然都是意外死亡,警方通過查閱死者的電腦和手機句柠,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進店門浦译,熙熙樓的掌柜王于貴愁眉苦臉地迎上來棒假,“玉大人,你說我怎么就攤上這事精盅∶毖疲” “怎么了?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵渤弛,是天一觀的道長祝拯。 經常有香客問我,道長她肯,這世上最難降的妖魔是什么佳头? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任,我火速辦了婚禮晴氨,結果婚禮上康嘉,老公的妹妹穿的比我還像新娘。我一直安慰自己籽前,他們只是感情好亭珍,可當我...
    茶點故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著枝哄,像睡著了一般肄梨。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上挠锥,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天众羡,我揣著相機與錄音,去河邊找鬼蓖租。 笑死粱侣,一個胖子當著我的面吹牛,可吹牛的內容都是我干的蓖宦。 我是一名探鬼主播齐婴,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼稠茂!你這毒婦竟也來了柠偶?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤主慰,失蹤者是張志新(化名)和其女友劉穎嚣州,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體共螺,經...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年情竹,在試婚紗的時候發(fā)現(xiàn)自己被綠了藐不。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 37,997評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖雏蛮,靈堂內的尸體忽然破棺而出涎嚼,到底是詐尸還是另有隱情,我是刑警寧澤挑秉,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布法梯,位于F島的核電站,受9級特大地震影響犀概,放射性物質發(fā)生泄漏立哑。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一姻灶、第九天 我趴在偏房一處隱蔽的房頂上張望铛绰。 院中可真熱鬧,春花似錦产喉、人聲如沸捂掰。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽这嚣。三九已至,卻和暖如春塞俱,著一層夾襖步出監(jiān)牢的瞬間姐帚,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工敛腌, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留卧土,地道東北人。 一個月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓像樊,卻偏偏與公主長得像尤莺,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子生棍,可洞房花燭夜當晚...
    茶點故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內容

  • 代碼中到處都需要命名颤霎。作為程序員,我們得給類命名涂滴,給變量命名友酱,給函數(shù)命名,給參數(shù)命名柔纵,給命名空間命名缔杉,等等等等。下...
    流哲羽閱讀 1,621評論 1 5
  • 閱讀《代碼整潔之道》有兩種原因搁料,第一種:你是個程序員或详;第二系羞,你想成為更好的程序員。讀完后霸琴,你能獲得如下技能: 知道...
    清風流蘇閱讀 1,028評論 0 2
  • 1.使用能夠表達意圖的名字 名字得能告訴我們它要做什么椒振,為什么存在,以及是如何工作的梧乘。選擇能夠表達意圖的名字澎迎,將更...
    恩德_b0c2閱讀 153評論 0 0
  • 每一個程序員都想寫出一段整潔而富有藝術感的代碼,讓寫代碼從枯燥乏味的過程轉化為可欣賞的藝術品选调。與世上其他很多事情相...
    RobertY閱讀 407評論 0 0
  • 我一直對于改變自己和接納自己這兩點有些迷茫夹供。 曾經一度想把自己改造成理想的樣子。明明不喜歡人多的場合学歧,卻偏偏逼自己...
    山林九閱讀 697評論 0 2