編寫可讀性代碼

臟話的頻率是衡量代碼好壞的標準

一、代碼應該易于理解

可讀性定理

別人理解它的時間最小化
并不是意味著代碼塊越小理解時間越短,有時候短的代碼可能花費更多的時間去讓被人理解。

理解代碼所需要的時間是否與其他目標沖突。

如良好的架構,易于測試。并不沖突。因為易于理解的代碼往往可以引向良好的架構和測試。

二、表面層次的改進

2.1、把信息裝進名字里

名字就是一個小小的注釋

1、選擇專業名詞

比如:getPage(url)這個方法名get就用的就比較不專業。我們無法得知他是從本地緩存取的網頁還是從互聯網。如果是從互聯網,可以使用fetch,或者download。

再比如,在寫樹的方法時候,我們用size()表達樹的高度,但是在閱讀時人們可能會產生疑惑,這個方法是得到樹的節點數嗎,于是得詳細閱讀代碼才能知道這個代碼是用來獲取什么。是不是使用height()的方法名表意更清楚呢,如果想獲得節點數,就使用NumNodes()方法名來表示。
那么,如何選擇專業名詞呢。
找到更有表現力的詞

image.png
2、避免使用泛泛的名字
3、用具體的名字代替抽象的名字
4、使用前綴或后綴給名字附加更多信息
5、決定名字長度

在小作用域里可以使用短名字

6、利用名字格式表達含義

2.2、代碼的審美

代碼采用好的審美可以提高代碼的可讀性,包括

1、可以重新安排換行,讓相似的代碼看起來盡可能相似
2、如果換行讓代碼依舊毫無美感,可以將相似的代碼提煉到一個方法里
3、在需要時使用列對齊,如果不是那么費功夫的話。
4、選一個有意義的順序,至始至終保持他。
5、可以把代碼的聲明按邏輯分組。
6、把代碼分成段落,用空行隔開。
7、保持個人風格的一致。

三、簡化循環

3.1、讓控制流變得易讀

1、注意條件語句參數的順序。

通常來說,被詢問的是放在左側

2、最小化嵌套

方式:1.使用continue 2、使用提早返回

3、減少讓可讀性變差的三目運算符、goto語句

3.2、拆分超長的表達式

1、引用解釋變量
2、使用摩根定理重寫代碼

3.3、變量與可讀性

1、減少變量和中間結果
2、縮小變量作用域
3、只寫一次變量,讓代碼更容易理解

四、重新組織代碼

4.1、抽取不相干的子問題

1、創建通用代碼、自底向上編碼
2、簡化已有接口或重塑接口

4.2、代碼只做一件事

4.3、用自然語言描述代碼

4.4、少些代碼

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

推薦閱讀更多精彩內容