Clean Code第二章:有意義的命名 --閱讀與討論

本章,作為整潔代碼的頭一步,致力于規范命名規則。

names.png

圖片來自<Clean Code>

所謂名不正則言不順,命名的好,代碼可讀性一下子就可以提高一大塊。

本章講解了十多種命名時的注意事項。

提到命名,使我想起譚浩強先生的書,我是從他的C語言編程書入門的。

雖說編程語言入門了,可那時養成了一些非常不好的編程習慣,給變量隨便命名,就是其中一種。

隨便摘一段該書中的代碼:

<pre>
long f1(int p)
{
int k;
long r;
long f2(int);
k=p*p;
r=f2(k);
return r;
}
</pre>

除了仔細看代碼外,基本看不出來該函數在干什么。

如果動輒幾萬行,幾十萬行的項目是這么命名,完全是慘不忍睹??!

一, 命名要名副其實

如果命名還需要注釋,那么該命名則是不合理的:
<pre>
int d; // elapsed time in days
</pre>

以下命名是合適的:
<pre>
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;
</pre>

命名增加了可讀性,例如如下代碼,看起來就不知所云:
<pre>
public List<int[]> getThem() {
List<int[]> list1 = new ArrayList<int[]>();
......
for (int[] x : theList)
if (x[0] == 4)
list1.add(x);
return list1;
}
</pre>
而如果是改成下面的兩種,代碼則清晰很多:
<pre>
public List<int[]> getFlaggedCells() {
List<int[]> flaggedCells = new ArrayList<int[]>();
......
for (int[] cell : gameBoard)
if (cell[STATUS_VALUE] == FLAGGED)
flaggedCells.add(cell);
return flaggedCells;
}
</pre>
或是
<pre>
public List<Cell> getFlaggedCells() {
List<Cell> flaggedCells = new ArrayList<Cell>();
......
for (Cell cell : gameBoard)
if (cell.isFlagged())
flaggedCells.add(cell);
return flaggedCells;
}
</pre>

二, 避免誤導

請避免使用與本意相混淆或相悖的詞。

例如,aix,sco,hp,不該作為變量名,因它們都是UNIX平臺上的專有名稱。

除非是List類型,否則不要用類似accountList來命名一組賬號,可以命名為accountGroup。

1和l,O和0很容易混淆,請注意使用。

三,有意義的區分

例如,ProductInfo和ProductData就沒有意義上的區別,很容易混淆。

廢話都是冗余的,例如Variable用于變量名中,Table用于表名中。

四,使用讀得出來的名稱

命名盡量別縮寫,時間長了誰都看不懂了。

以下命名,對比一下,哪個更容易讀明白:
<pre>
class DtaRcrd102 {
private Date genymdhms;
private Date modymdhms;
private final String pszqint = "102";
/* ... /
};
</pre>
<pre>
class Customer {
private Date generationTimestamp;
private Date modificationTimestamp;
private final String recordId = "102";
/
... */
}
</pre>

五,使用可搜索的名稱

如果變量可能在代碼中多處使用,則應賦以便于搜索的名稱。變量作用域越大,越需要精心命名以便搜索。

例如,如果一星期5天的“5”經常被使用,則將其命名為WORK_DAYS_PER_WEEK要比“5”好搜索的多。

六,盡量避免使用編碼和成員前綴等“舊時代”規則

例如,匈牙利標記法,成員前綴(m_dsc等等)?,F在的編程里,這種前綴和標記法的命名方法越來越少見了。

例如,抽象工廠及其實現,

可以寫成:IShapeFactgory和ShapeFactory,

也可以寫成ShapeFactory及ShapeFactoryImp.

作者推薦后者的寫法。

七,避免思維映射

盡量別用腦中熟悉的縮寫,來取變量名。

例如,i在編程人員眼中,經常代表index.但最好用當時有意義的名稱來替代i.

八,類名

類名應當是名詞或名詞短語,例如Customer,WikiPage,AddressParser。

請避免用太通用的Data,Info等詞。

類名不應該是動詞。

九,方法名

方法名應該是動詞或動詞短語,例如:postPayment,deletePage或者save.

如果是屬性訪問,則加上"get","set","is"等前綴。

十,別扮可愛(賣萌)

別用俗語來做名稱。

例如whack()來表示kill()等。

十一,每個概念對應一個詞

請給每個抽象概念選一個詞,并一以貫之。

例如,如果fetch,retrieve,get并列出現在方法名里,你怎么知道用哪個?

Controller和Driver,Manager也是令人困惑的一組詞。

十二,別用雙關語

請避免同一術語用于不同概念。例如,add方法,如果用于collection時,則應該叫append或insert更貼切。

十三,使用計算機科學領域的名稱還是問題域的名稱

如果能用計算機科學領域的術語,則盡量使用。因只有程序員才會讀你的代碼。

例如,AccountVisitor,程序員一看就知道這是訪問者模式。

如果不能用程序員所熟悉的術語,則采用所涉問題領域來的名稱。

至少,看到該名稱,能聯想到去找該領域專家來詢問所需知識。

十四,添加有意義的語境

看到一個state變量,可能不知道它是什么意思,但如果是addrState,很容易看出它是地址的一部分。

如果state是Address類的成員,含義就更清晰了。

十五,不要添加沒意義的語境

例如,給每個類添加一個全局前綴,一般都沒有意義。因為所有的類都有此前綴,則變成了沒有區別。

問題:

1,你所寫過,改過或看過的代碼中,有哪些是命名很糟糕的,請舉例。

2,有哪些是命名很不錯的,也請舉例。

3,此章中命名的規范里,哪些是你已經遵守了的規則,哪些是你忽略了的?

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

推薦閱讀更多精彩內容