編程命名中的7+1個(gè)提示

1.- 變量應(yīng)該是盡可能的望文知意。千萬(wàn)不要使用教材中的命名方式。

• 好的變量： daysDateRange, flightNumber, carColor.
• 壞的變量： days, dRange, temp, data, aux…

在我們的日常工作中，有很大數(shù)量的開發(fā)人員喜歡使用短的變量名，而不是有含義的變量名。這主要是因?yàn)槲覀兇髮W(xué)教科書的那些示例所造成的，人都是先入為主，所以，教科書中的那些很抽象，帶著演示的變量命名影響了我們一代又一代的程序員，并影響了他們很多年。雖然那些短的，教材式的變量名，可能會(huì)讓你少打一些字，但其實(shí)，這是非常非常不好的。因?yàn)檐浖木S護(hù)成本遠(yuǎn)遠(yuǎn)大于了軟件的開發(fā)成本，如果你不取一個(gè)好的一點(diǎn)的變量名，那么當(dāng)進(jìn)行代碼評(píng)審時(shí)，當(dāng)進(jìn)行bug fixing時(shí)，當(dāng)進(jìn)行代碼重構(gòu)時(shí)，當(dāng)進(jìn)行代碼維護(hù)時(shí)，你的某個(gè)變量名可能會(huì)讓你一頭霧水，不知道所措，還可以會(huì)讓你走入陷阱，造成更大的時(shí)間成本。所以，一個(gè)可閱讀的代碼必然和那些不錯(cuò)的變量名分不開，而這也能讓你的軟件間接上有更好的質(zhì)量。

2.- 變量名不要太長(zhǎng)，盡可能地簡(jiǎn)短

只有簡(jiǎn)單和簡(jiǎn)短的變量名才是容易閱讀的。因?yàn)槟愕淖兞棵欢〞?huì)用于程序語(yǔ)句中，所以，為了讓你的程序語(yǔ)句看起來的簡(jiǎn)短，你的變量名也應(yīng)該短一點(diǎn)，不然寫出來的一個(gè)表達(dá)式就會(huì)顯得很復(fù)雜。

當(dāng)然，在有些時(shí)候，一個(gè)有含義的變量名和一個(gè)簡(jiǎn)短的變量名可能存在一些沖突。這相當(dāng)鍛煉我們的語(yǔ)言能力——如果有最精煉的詞語(yǔ)來表達(dá)最豐富的含義。如果實(shí)在做不到，那么，取一個(gè)有含義的變量名要比取一個(gè)簡(jiǎn)短的變量名更好一些。不管怎么樣，我們希望即簡(jiǎn)短又有豐富的含義，但如果不能兩全，那有含義優(yōu)先級(jí)更高一些。

• 壞的變量：howLonDoesItTakeToOpenTheDoor， howBigIsTheMaterial…
• 好的變量：timeToOpenTheDoor， MaterialSize.

3.- 可以使用縮寫，但需要有一些注釋

有一些時(shí)候，我們需要使用一些縮寫來命名變量，比如：用usr來表示user，用gp來表示group，用conf來表示configuration，用cwd來表示current working directory，用ptr來代碼point to reference，等等，等等?？s寫一般要用在大家可以看得懂的，而不是為了縮寫而縮短一個(gè)單詞，當(dāng)然，如果你把縮寫后的變量名加上注釋，那就更加穩(wěn)妥了。關(guān)于一些約定俗成的縮寫，可參看本文的附錄一。

4.- 使用合適的匈牙利命名規(guī)則

這里有一篇非常不錯(cuò)的英文文章告訴你 《什么是合適的匈牙利命名 》，這篇文章同時(shí)還告訴你如何去用他?；旧蟻碚f，匈牙利命名法主要是為變量加上某種前綴以標(biāo)識(shí)這個(gè)變量的類型，或是一種方法的功能。其基本原則是：變量名＝屬性＋類型＋對(duì)象描述。

比如：在描述類型方面：指針p，函數(shù)fn，長(zhǎng)整型 l，布爾b，浮點(diǎn)型（有時(shí)也指文件）f，雙字 dw，字符串 sz，短整型 n，雙精度浮點(diǎn) d，無(wú)符號(hào) u……等等。關(guān)于更多的命名規(guī)范，請(qǐng)參見附錄二。

注意，匈牙利命名也是有不好的地方的，比如你要把一個(gè)整形改成一個(gè)浮點(diǎn)型，你除了要改變這個(gè)變量的類型，你還要改變這個(gè)變量的名字。這是相當(dāng)麻煩的。而且，在某些時(shí)候，這種前綴式的命名可以反而讓你不知所措。另外，在C++中，有了類以后，這種命名方法就顯得不容易去實(shí)施了。所以，合適地使用匈牙利命名方式背后的思想是很關(guān)鍵的。

5.- 不要使用反邏輯來命名

• 好的命名：  IsEnabled.
• 壞的命名： IsNotEnabled.

在閱讀的時(shí)候，我們更喜歡正向的邏輯，而不是反向邏輯。這一規(guī)則不單單的命名，在條件語(yǔ)句中，我們也是要盡量不要使用這種反面的邏輯。如：if (! (isAdmin || isUser))，這樣的語(yǔ)句很不符合人讀代碼的習(xí)慣，寫成這樣會(huì)更好一些——if (!isAdmin && !isUser)。

6.- 保持一致性

保持所有代碼的一致性。使用相同的命名規(guī)則。這外世界上沒有最好的命名規(guī)范。但有一點(diǎn)是可以確認(rèn)的，那就是在一個(gè)代碼庫(kù)中，應(yīng)該使用一致的命名規(guī)則，即使這個(gè)規(guī)則不那么好，但整個(gè)團(tuán)隊(duì)使用一致的就是好的。

7.- 附和應(yīng)用程序的領(lǐng)域術(shù)語(yǔ)

在不同的領(lǐng)域中，不同的觀念會(huì)有非常特別和不同的意思。例如：?jiǎn)卧~“order”并不總是意味著“次順”，有些時(shí)候，其意味著“訂單”，有些時(shí)候，意味著“命令”，有些時(shí)候，意為著“規(guī)則”。所以，在某個(gè)領(lǐng)域中，某些單詞會(huì)有不同的含義，所以，這需要我們的命令去附和這些領(lǐng)域。

黃金法則- 花一些時(shí)間去思考去權(quán)衡一下你的變量名

當(dāng)你設(shè)計(jì)好一個(gè)的變量名一個(gè)函數(shù)名的時(shí)候，別著急去使用他，停下來，想一想，這個(gè)變量名是否合適，是否還有更好的？也許你正在使用的是一個(gè)很不好的變量名。有些時(shí)候，需要我們權(quán)衡利弊一下，可能還要去和同事討論一下。

總之，變量名是編程的第一步，第一步走好了，后面才走得好。試想，無(wú)論是你或你的同事在使用一些好的變量名編程是一件多么輕松的事啊。