建站
咨詢
售后
建站咨詢
新聞中心
這次先從命名說(shuō)起。
當(dāng)我們看到一份設(shè)計(jì)圖或一份代碼時(shí)，大多數(shù)人會(huì)【望文生義】。但使人【望文生義】卻正是語(yǔ)言文字的根本使命。
因此，如果一個(gè)函數(shù)被命名為Add()，但內(nèi)部實(shí)際做的是減法，那么這份設(shè)計(jì)或者這份代碼，一定是很難理解的。
于是一個(gè)非?，F(xiàn)實(shí)的問題就擺在了我們的面前：我們究竟應(yīng)該如何為類，為方法等等命名？
以命名而論，有兩個(gè)較大的陷阱：一個(gè)是名實(shí)不符，一個(gè)是詞義混淆。
名實(shí)不符的常見情形又有兩類。比如：
以偏概全。假設(shè)說(shuō)一個(gè)方法被命名為OutputLineNumber()，但實(shí)際上這個(gè)方法會(huì)在分析源文件后，同時(shí)輸出LineNumber和指定行號(hào)下的內(nèi)容大而無(wú)當(dāng)。假使說(shuō)一個(gè)類被命名為XMLHandler，那么看得人基本不能從這個(gè)名字上獲得有效信息。這主要是由于Handler這個(gè)詞的含義過于寬泛。
上文所說(shuō)的命名為Add()但實(shí)際做減法操作是名實(shí)不符的極端情形，達(dá)到了名實(shí)相反的地步。
詞義混淆則源自語(yǔ)言文字自身的限制。常表現(xiàn)為一詞多義或多詞一義。
語(yǔ)言文字可以被看成是一種表意的符號(hào)系統(tǒng)，這個(gè)符號(hào)系統(tǒng)的典型特征是其模糊性。
同一個(gè)意思可以有許多種表達(dá)方法。比如說(shuō)：index和number是兩個(gè)不同的詞，但很多時(shí)候其意義互相重疊。而假如說(shuō)一個(gè)變量名為fileNumber，那么這個(gè)變量既可以代表文件的總數(shù)，也可以代表某個(gè)具體文件的編號(hào)。
上述問題會(huì)因?yàn)橛⒄Z(yǔ)不是我們的母語(yǔ)而變得更為麻煩。
名實(shí)不符與詞義混淆這類陷阱的一個(gè)主要觸發(fā)條件是軟件自身的不停衍化。
在之前的文章里曾經(jīng)提到過，對(duì)于概念和邏輯的認(rèn)知是一個(gè)逐層遞進(jìn)的過程。
在這一過程中，包，類，方法等的內(nèi)涵必然會(huì)發(fā)生變更。變更無(wú)疑的會(huì)使名實(shí)不符這類問題加劇。比如：一個(gè)類原本負(fù)責(zé)輸出測(cè)試結(jié)果，這時(shí)候OutputTestResult這樣的命名可能是合適的?？呻S著軟件功能的增強(qiáng)，最終可能不知要輸出結(jié)果，還要對(duì)結(jié)果進(jìn)行一定分析和統(tǒng)計(jì)。這樣原來(lái)的命名就顯的有些不合適了。
在對(duì)命名這一問題的根源進(jìn)行分析之后，我們來(lái)看看可能的應(yīng)對(duì)方法。
命名問題事實(shí)上并不能只在命名這一環(huán)節(jié)進(jìn)行解決，首先要有容易命名的對(duì)象，接下來(lái)才有容易命名的事實(shí)。
比如說(shuō)：是先有貓和狗這類外在特征不同的動(dòng)物，接下來(lái)我們才用貓和狗這樣不同的名字來(lái)稱呼他們，而非相反。
如果概念之間是正交的，概念的邊界也是清晰的，那么命名無(wú)疑會(huì)容易很多。好的設(shè)計(jì)是改善命名的基礎(chǔ)。
也就是說(shuō)，很多時(shí)候我們感到命名困難，真正原因可能并非是命名的技能不夠，而是設(shè)計(jì)還不夠優(yōu)化。
在努力改善設(shè)計(jì)之后，才需要面對(duì)純粹的命名問題。
從本質(zhì)上來(lái)看，命名問題并不是一個(gè)編程的問題，而是一個(gè)表達(dá)的問題。命名最終對(duì)讀程序的人負(fù)責(zé)。
有些表達(dá)上的基本原則對(duì)于解決命名問題會(huì)有些幫助，比如：
尊重既成事實(shí)
無(wú)疑的每個(gè)人都是有創(chuàng)造性的，但在命名的時(shí)候發(fā)揮創(chuàng)造性則更可能是有害的。比如說(shuō)：在XML的世界中一般使用sibling這個(gè)詞來(lái)表示兄弟節(jié)點(diǎn)，這種時(shí)候就不需要?jiǎng)?chuàng)造性的使用brother node這樣的自制詞匯了。
用完整詞匯
對(duì)一般人而言要求事先記憶幾十個(gè)縮寫詞，而后來(lái)讀程序是不太可能的事情。所以如果一個(gè)程序中充滿_Tx和CSCP這樣的特制符號(hào)的話，那這樣的程序幾乎一定是不容易懂的。
一個(gè)典型的反例是P.J Plauger版的C++標(biāo)準(zhǔn)模板庫(kù)。也許是出于隱藏實(shí)現(xiàn)細(xì)節(jié)的目的，這份標(biāo)準(zhǔn)模板庫(kù)的實(shí)現(xiàn)里面幾乎完全不用完整詞匯。如果想體驗(yàn)一下不用完整詞匯的后果，那么可以讀一下這里面的代碼。
要具體
具體是一個(gè)方向。
比如說(shuō)：可以用OutputLinenumber()的時(shí)候，就不要用Output()。而可以用OutputCppLinenumber()的時(shí)候就不要用OutputLinenumber()。
多人協(xié)作的時(shí)候，使用統(tǒng)一規(guī)范
這條規(guī)則最終會(huì)導(dǎo)致常說(shuō)的Coding Rule。對(duì)具體如何定義Coding Rule，《代碼大全》一書中給出了詳細(xì)的指導(dǎo)，這里就不在說(shuō)明了。
有一點(diǎn)需要補(bǔ)充的是，就和說(shuō)話的時(shí)候記不住語(yǔ)法一樣，設(shè)計(jì)或做編碼的人往往也記不住編碼規(guī)則。所以規(guī)則也不宜過多。如果必須詳細(xì)，那么至少要主次分明。比如說(shuō)：統(tǒng)一使用主賓結(jié)構(gòu)還是使用動(dòng)賓結(jié)構(gòu)這樣的選擇會(huì)影響程序的大部分內(nèi)容，那么就應(yīng)該優(yōu)先統(tǒng)一。
原文鏈接：http://www.cnblogs.com/daoshi/archive/2012/04/23/2465812.html
網(wǎng)站欄目：程序員談編碼質(zhì)量與命名
標(biāo)題網(wǎng)址：http://www.5511xx.com/article/ccodhji.html
