讀代碼整潔之道

代碼整潔之道,Clean Code,作者是美國的Robert C.Martin,寫這個我只是為了提高這本書的格調~~


這里寫圖片描述

這本書是我前一段時間讀的,讀過之后對我編程有很大的影響,建議程序員同志們閱讀一下。簡單說一下我從里面收獲的最重要的觀點,做個簡單的書摘,歡迎討論~~

1. 有意義的命名

這個對于程序員來說并不陌生,但是什么樣才算做有意義書里進行了詳細的講解。

(1)避免誤導:比如accountList表示一組賬號,如果它并不是List類型,那么就會引起錯誤的判斷,因為List對程序員來說是一個特殊的類。

(2)沒有廢話、不冗余:比如Variable永遠不應該出現在變量名之中。
(3)讀起來清晰易懂:比如某家公司中有genymdhms這樣一個函數(表示生成日期、年、月、日、時、分、秒),讀起來晦澀,簡直是糟糕的命名方式。
(4)便于搜索:比如某個變量表示一周的天數,用7這個數字遠遠不如定義一個A_WEEK_DAYS這樣的常量容易被搜索到進行修改或者查詢。
(5)命名增加變量類型:比如String strTemperature中的str表示變量類型,這個在實際閱讀過程中會被忽略,在編程過程中也并沒有起到很好的作用,反而增加了修改代碼的難度和閱讀代碼的難度。這里我個人經常寫android的時候這樣用,主要是用于區分控件,因為一個界面的控件名比較容易重復,所以我個人覺得如果從命名區分的角度來講還是可以加類型的。
(6)符合普遍思維,不用雙關語:比如add、insert、append之間的區別要搞清楚,對于方法的命名要清晰。

2. 函數

函數的寫法和命名是決定這整個程序是否易讀的關鍵點。
(1)短小:曾經說函數不應該超過一屏,后來說20行封頂最佳,實際上一個函數應該做的就是做一層的工作,相當于一個while,或者一個if、else結構,要縮到最短才是合格的函數。當然比如說像android中findviewbyid()這種需要大量copy的代碼,自然要很多行,其實文中的意思是要縮短一個函數的邏輯長度,所以對于邏輯函數應該不超過10行左右。
(2)只做一件事:比如顯示一個手機屏幕上的控件函數,需要顯示所有的TextView和所有的Button,那么這就是兩件事兒,要分成兩個函數來寫,不能混在一起。
(3)函數參數:最理想的是零參數函數,其次是一,再次是二,應盡量避免三,有足夠特殊的理由才能使用三個以上參數。主要原因在于,一旦有參數就需要你了解函數更多地細節,從測試的角度來說更叫人為難,參數越多測試用例越復雜。
(4)標識參數:標志參數丑陋不堪,向函數傳入布爾值簡直就是駭人聽聞的做法。這樣做大聲宣布函數不止做一件事,違反了第二條,應該將其分為兩個函數分別調用。
(5)參數對象:如果函數看來需要兩個、三個或三個以上參數,說明其中一些參數應該封裝為類了。
(6)使用異常代替返回錯誤碼:不要用一層層的if、else在不同的情況去輸出不同的錯誤碼,而應該用異常直接獲取錯誤,代碼整體立馬簡潔易讀。
(7)錯誤處理就是一件事:因為函數應該只做一件事,所以錯誤處理就是一件事。
放個圖,解釋一下什么叫做簡潔的函數:


這里寫圖片描述

3. 注釋

文中有一個對于注釋非常鮮明的觀點,這句話是這樣的:注釋的恰當用法是彌補我們在用代碼表達意圖時遭遇的失??!注釋是一種失??!因為找不到不用注釋表達自我的方法,所以要有注釋,這并不值得慶賀。
為什么要極力貶低注釋?因為注釋會撒謊,注釋存在的時間越久,離其所描述的代碼越遠,越來越變得全然錯誤,原因就是程序員不能堅持維護注釋。比如我自己代碼中的一個例子:


這里寫圖片描述

注釋不能美化糟糕的代碼
用代碼來闡述不要用注釋
下面講講好注釋都可能有哪些:
(1)法律信息,不過更好的是指向一份標準許可或者其他文檔;
(2)表示返回值含義,不過其實也可以用函數命名來彌補;
(3)或者解釋某種臨時的解決方案;
(4)警示使用該代碼的后果;
(5)todo注釋,表示應該做但是還沒做的事情,但是這是必須立刻解決掉的注釋。
再帶大家看看壞注釋都有什么。
(1)喃喃自語。。。
(2)多余的注釋,如下圖,讀這段注釋花的時間沒準比讀代碼花的時間還要長


這里寫圖片描述

(3)循規式注釋,如下圖,非要給函數加上注釋解釋變量含義。
這里寫圖片描述

(4)日志式注釋,如下圖,在已經有源代碼控制系統可用的今天,這種冗長的記錄只會讓模塊變得凌亂不堪,應當全部刪除
這里寫圖片描述

(5)廢話注釋:如下圖,不多說了,看看就懂了


這里寫圖片描述

這里寫圖片描述

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

推薦閱讀更多精彩內容