凱開 x 慵懶日子

圖來自博客來，可點擊前往

易讀程式之美學：提升程式碼可讀性的簡單法則
作者： Dustin Boswell、Trevor Foucher
譯者：莊弘祥
出版社：歐萊禮
出版日期：2013/04/30
語言：繁體中文

今天因為雅如在教我怎麼用jquery運用在下拉式選單下可以隨著點擊更動文字及圖片，有提到每個id跟class命名都有它的原因的連圖片命名最好都要思考一下。最後小黑來才知道原來有本書教許多我不知清楚的咩咩嘎嘎，發現團隊有這本書馬上就借來看啦!!!希望之後我寫的東西也容易理解閱讀。

我承認有很多該注意的小細節我真的都覺得無所謂，但久而久之也真的忘了自己為什麼要那樣命名，那到底是要做什麼。但完全沒想到這可能造成別人困擾也讓自己不方便。

來筆記一下。蠻像在偷備份的XD

一、程式碼應該易於理解

易於理解比簡潔更加好，也不妨加上註解

Part 1.表層改善

二、富含資訊的名稱

使用特定詞彙：使用 Fetch 或 Download 可能比 get 來的好

避免通用名稱：ex. tmp , retval

使用具體名稱：更明確說明細節

在名稱中加入重要細節：ex. 代表毫秒可加上 _ms

在較大的範圍使用較長的名稱：短名稱適合只有數行的變數

有意義的使用大寫、底線等符號：可加上 _ 區分類別成員與區域變數

三、不被誤解的名稱

不容易被誤用的名稱

最好名稱避免誤會

定義數值上下限，max_ & min。閉區間，first & last 。對半開放區間，begin & end。

命名布林值，使用 is 或 has 明確表示布林值的意義。避免否定詞彙

對特地單字預期，ex. 使用者會認為 get() 或 size 是輕量級方法

四、美學，覺得這章主要是講排版

有相似的行為，讓他有相同排版

有技巧的攔對齊，有技巧的斷行讓程式更易讀

使用相同的順序，不要原本A、B、C，後來變B、A、C

利用空白行將大區塊切割成有意義的「段落」

五、認識註解，重要概念：註解目的是讓使用者了解程式碼在做什麼。

不該註解的地方，好程式>壞程式+好註解

記錄自己想法

為使用者設想

提早寫註解是件好事。