《編寫可讀代碼的藝術(shù)》讀書筆記(上)表面層次的改進(jìn)

最近在看《編寫可讀代碼的藝術(shù)》到涂,在這里記錄一下點(diǎn)點(diǎn)滴滴

代碼應(yīng)當(dāng)易于理解##

可讀性基本定律:代碼的寫法應(yīng)當(dāng)使被人理解它所需的時(shí)間最小化府蛇,但并不是越小越好判帮,要注意理解代碼所需的時(shí)間是否與其他目標(biāo)有沖突

第一部分:表面層次的改進(jìn)###

  • 選擇好的名字
  • 寫好的注釋
  • 把代碼整潔的寫成更好的格式
選擇好的名字(名稱語義化)
  • 選擇專業(yè)的詞 (不使用Get,使用Fetch或者Download等更專業(yè)的詞)
  • 避免泛泛的名字(例如temp)
  • 用具體的名字代替抽象的名字
  • 使用前綴或后綴來給名字附帶更多信息
  • 決定名字的長(zhǎng)度(小的作用域使用短的名字轨奄,丟掉沒有用的詞ConvertToString簡(jiǎn)介為ToString)
  • 利用名字的格式來表達(dá)含義(例如大寫代表常量min和max等)
代碼整潔的寫成更好的格式(提高審美)
  • 使用一致的布局,讓讀者很快就習(xí)慣這種風(fēng)格
  • 讓相似的代碼看上去相似
  • 把相關(guān)的代碼行分組敲才,形成代碼塊

提高代碼審美的技巧

  • 重新安排換行來保持一致和緊湊
  • 用方法來整理不規(guī)則的東西
  • 在需要時(shí)使用列對(duì)齊
  • 選一個(gè)有意義的順序始終一致的使用它
  • 把聲明按塊組織起來(比如方法和變量聲明應(yīng)該自成一塊)
  • 個(gè)人風(fēng)格的一致性(一致的風(fēng)格比“正確”的風(fēng)格更重要)
該寫什么樣的注釋(注釋物有所值)
  • 不要為了注釋而注釋
  • 不要給不好的名字加注釋(先把名字改好)
  • 記錄你的思想
    • 加入導(dǎo)演評(píng)論(自己的見解)
    • 為代碼中的瑕疵寫注釋(同時(shí)可以寫一些要做的事)
    • 給常量加注釋
  • 站在讀者角度
  • 公布可能的陷阱
  • 全局觀注釋(團(tuán)隊(duì)的新成員快速熟悉代碼)
  • 總結(jié)性注釋
  • 克服作者心理阻滯
寫出言簡(jiǎn)意賅的注釋(注釋應(yīng)當(dāng)有很高的信息)
  • 讓注釋保持緊湊
  • 避免使用不明確的代詞
  • 潤色粗糙的句子
  • 精確的描述函數(shù)(方法)的行為
  • 聲明代碼的意圖
  • 采用信息含量高的詞
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末谆刨,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子归斤,更是在濱河造成了極大的恐慌,老刑警劉巖刁岸,帶你破解...
    沈念sama閱讀 218,204評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件脏里,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡虹曙,警方通過查閱死者的電腦和手機(jī)迫横,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,091評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來酝碳,“玉大人矾踱,你說我怎么就攤上這事∈杌” “怎么了呛讲?”我有些...
    開封第一講書人閱讀 164,548評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我贝搁,道長(zhǎng)吗氏,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,657評(píng)論 1 293
  • 正文 為了忘掉前任雷逆,我火速辦了婚禮弦讽,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘膀哲。我一直安慰自己往产,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,689評(píng)論 6 392
  • 文/花漫 我一把揭開白布某宪。 她就那樣靜靜地躺著仿村,像睡著了一般。 火紅的嫁衣襯著肌膚如雪缩抡。 梳的紋絲不亂的頭發(fā)上奠宜,一...
    開封第一講書人閱讀 51,554評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音瞻想,去河邊找鬼压真。 笑死,一個(gè)胖子當(dāng)著我的面吹牛蘑险,可吹牛的內(nèi)容都是我干的滴肿。 我是一名探鬼主播,決...
    沈念sama閱讀 40,302評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼佃迄,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼泼差!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起呵俏,我...
    開封第一講書人閱讀 39,216評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤堆缘,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后普碎,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體吼肥,經(jīng)...
    沈念sama閱讀 45,661評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,851評(píng)論 3 336
  • 正文 我和宋清朗相戀三年麻车,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了缀皱。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,977評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡动猬,死狀恐怖啤斗,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情赁咙,我是刑警寧澤钮莲,帶...
    沈念sama閱讀 35,697評(píng)論 5 347
  • 正文 年R本政府宣布免钻,位于F島的核電站,受9級(jí)特大地震影響臂痕,放射性物質(zhì)發(fā)生泄漏伯襟。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,306評(píng)論 3 330
  • 文/蒙蒙 一握童、第九天 我趴在偏房一處隱蔽的房頂上張望姆怪。 院中可真熱鬧,春花似錦澡绩、人聲如沸稽揭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,898評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽溪掀。三九已至,卻和暖如春步鉴,著一層夾襖步出監(jiān)牢的瞬間揪胃,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,019評(píng)論 1 270
  • 我被黑心中介騙來泰國打工氛琢, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留喊递,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,138評(píng)論 3 370
  • 正文 我出身青樓阳似,卻偏偏與公主長(zhǎng)得像骚勘,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子撮奏,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,927評(píng)論 2 355

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

  • 前言:人生有很多第一次俏讹,作為一只不諳世事的小程序媛,第一次踏出校門畜吊,開始實(shí)習(xí)泽疆,感觸良多,其中玲献,頗為震撼的一點(diǎn)是于微,原...
    sunnyaxin閱讀 973評(píng)論 3 4
  • 0. 前言 程序員給人的印象大多都是蓬頭垢面,衣著隨意青自。然而,我認(rèn)為一個(gè)優(yōu)秀的程序員對(duì)于代碼一定有他的審美驱证。如果你...
    書呆子的復(fù)仇閱讀 614評(píng)論 0 0
  • 以下是書里文字的引用與整理 前言 可讀性基本定理:代碼的寫法應(yīng)當(dāng)使別人理解它所需的時(shí)間最小化延窜。 一、表面層次的改進(jìn)...
    消失3003閱讀 1,753評(píng)論 0 5
  • 一副皮囊抹锄,斗不過日月 一腔熱血逆瑞,耐不過經(jīng)年 歲年長(zhǎng)荠藤,恍恍惚惚 已是二八年紀(jì) 卻未有勞心之去處 夢(mèng)猶在,真真切切 非...
    天光_娜娜閱讀 105評(píng)論 0 0
  • 一太太获高,偶然間獲得一花瓶哈肖,對(duì)此,甚是歡喜念秧,便每日都要細(xì)細(xì)欣賞與把玩淤井,日復(fù)一日,年復(fù)一年摊趾,對(duì)花瓶的喜愛卻分毫...
    度_e885閱讀 278評(píng)論 0 0