基于《Clean code 》的代碼實踐

編寫干凈哩罪、可理解和可維護(hù)的代碼是每個開發(fā)人員必須掌握的關(guān)鍵技能。
在這篇文章中,我們將著眼于提高代碼質(zhì)量的最重要的原則片排,并為您提供每個原則的代碼示例。
大多數(shù)例子都取自Robert J. Martin的《Clean Code》速侈。這是一本編程經(jīng)典率寡,如果有時間,建議閱讀全文锌畸。

1. 創(chuàng)建有意義的變量名

不要使用注釋去解釋一個變量名的定義勇劣,如果一個變量需要用注釋,我們應(yīng)該考慮如何重命名潭枣,使我們的變量更表意比默。

"A name should tell you why it exists, what it does, and how it is used. If a name requires a comment, then the name does not reveal its intent." ? ? ? ? ? ? ? ? – Clean Code

Bad example:

var d; // elapsed time in days

Good example:

var elapsedTimeInDays;
var daysSinceCreation;
var daysSinceModification;

2.?避免歧義

小心那些有特定含義的詞。例如不要將帳戶分組命名為accountList盆犁,除非它的type確實是List命咐。這個詞有特定的含義,它可能會導(dǎo)致錯誤的結(jié)論谐岁。
即使type是list醋奠,比起accountList, accounts是一個更好的選擇

3. 避免無意義的單詞(噪聲詞)

噪聲詞是指不提供關(guān)于變量的任何附加信息的詞。它們是多余的伊佃,應(yīng)該刪除窜司。
一些使用頻繁的噪聲詞:

- The (prefix)

- Info

- Data

- Variable

- Object

-?Manager

如果你定義的變量名是userInfo,你可以直接修改為user; 如果你定義的方法名是getOrderData航揉,你可以直接命名為getOrder塞祈。去掉這些噪聲詞,依然不影響我們根據(jù)變量名來理解所定義的變量的意義帅涂,而且我們的變量名也變得更加簡潔议薪。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市媳友,隨后出現(xiàn)的幾起案子斯议,更是在濱河造成了極大的恐慌,老刑警劉巖醇锚,帶你破解...
    沈念sama閱讀 216,692評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件哼御,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)艇搀,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,482評論 3 392
  • 文/潘曉璐 我一進(jìn)店門尿扯,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人焰雕,你說我怎么就攤上這事衷笋。” “怎么了矩屁?”我有些...
    開封第一講書人閱讀 162,995評論 0 353
  • 文/不壞的土叔 我叫張陵辟宗,是天一觀的道長。 經(jīng)常有香客問我吝秕,道長泊脐,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,223評論 1 292
  • 正文 為了忘掉前任烁峭,我火速辦了婚禮容客,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘约郁。我一直安慰自己缩挑,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,245評論 6 388
  • 文/花漫 我一把揭開白布鬓梅。 她就那樣靜靜地躺著供置,像睡著了一般。 火紅的嫁衣襯著肌膚如雪绽快。 梳的紋絲不亂的頭發(fā)上芥丧,一...
    開封第一講書人閱讀 51,208評論 1 299
  • 那天,我揣著相機(jī)與錄音坊罢,去河邊找鬼续担。 笑死,一個胖子當(dāng)著我的面吹牛活孩,可吹牛的內(nèi)容都是我干的物遇。 我是一名探鬼主播,決...
    沈念sama閱讀 40,091評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼诱鞠,長吁一口氣:“原來是場噩夢啊……” “哼挎挖!你這毒婦竟也來了这敬?” 一聲冷哼從身側(cè)響起航夺,我...
    開封第一講書人閱讀 38,929評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎崔涂,沒想到半個月后阳掐,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,346評論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,570評論 2 333
  • 正文 我和宋清朗相戀三年缭保,在試婚紗的時候發(fā)現(xiàn)自己被綠了汛闸。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,739評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡艺骂,死狀恐怖诸老,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情钳恕,我是刑警寧澤别伏,帶...
    沈念sama閱讀 35,437評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站忧额,受9級特大地震影響厘肮,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜睦番,卻給世界環(huán)境...
    茶點故事閱讀 41,037評論 3 326
  • 文/蒙蒙 一类茂、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧托嚣,春花似錦巩检、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,677評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至丑搔,卻和暖如春厦瓢,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背啤月。 一陣腳步聲響...
    開封第一講書人閱讀 32,833評論 1 269
  • 我被黑心中介騙來泰國打工煮仇, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人谎仲。 一個月前我還...
    沈念sama閱讀 47,760評論 2 369
  • 正文 我出身青樓浙垫,卻偏偏與公主長得像,于是被迫代替她去往敵國和親郑诺。 傳聞我的和親對象是個殘疾皇子夹姥,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,647評論 2 354

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