3/20/2009

[ C# ] 編碼命名規範

[轉貼http://www.purecs.net/thread/topic684_1.aspx]抨擊匈牙利命名法

匈牙利命名法是一種編程時的命名規範。命名規範是程序書寫規範中最重要也是最富爭議的地方,自古乃兵家必爭之地。命名規範有何用?四個字:名正言順。用二分法,

命名規範分為好的命名規範和壞的命名規範,()絡育Z|_%$J也就是說名正言順的命名規範和名不正言不順的命名規範。好的舞鞋是讓舞者感覺不到其存在的舞鞋,壞的舞鞋是讓舞者帶著鐐銬起舞。一個壞的命名規範具有的破壞力比一個好的命名規範具有的創造力要大得多。

本文要證明的是:匈牙利命名法是一個壞的命名規範。本文的作用範圍為靜態強類型編程語言。本文的分析範本為C語言和C++語言。下文中的匈法為匈牙利命名法的簡稱。

一 匈牙利命名法的成本

匈法的表現形式為給變量名附加上類型名前綴,例如:nFoo,szFoo,pFoo,cpFoo分別表示整型變量,字符串型變量,指針型變量和常指 針型變量。可以看出,匈法將變量的類型信息從單一地點(聲明變量處)複製到了多個地點(使用變量處),這是冗餘法。冗餘法的成本之一是要維護副本的一致 性。這個成本在編寫和維護代碼的過程中需要改變變量的類型時付出。冗餘法的成本之二是佔用了額外的空間。一個優秀的書寫者會自覺地遵從一個法則:代碼最小 組織單位的長度以30個自然行以下為宜,如果超過50行就應該重新組織。一個變量的書寫空間會給這一法則添加不必要的難度。

二 匈牙利命名法的收益

這裡要證明匈牙利命名法的收益是含糊的,無法預期的。

範本1:strcpy(pstrFoo,pcstrFoo2) Vs strcpy(foo,foo2)
匈法在這裡有什麼收益呢?我看不到。沒有一個程序員會承認自己不知道strcpy函數的參數類型吧。

範本2:unknown_function(nFoo) Vs unknown_function(foo)
匈法在這裡有什麼收益呢?我看不到。對於一個不知道確定類型的函數,t.-.-7`FxgV網管程 序員應該去查看該函數的文檔,這是一種成本。使用匈法的唯一好處是看代碼的人知道這個函數要求一個整型參數,這又有什麼用處呢?函數是一種接口,參數的類 型僅僅是接口中的一小部分。諸如函數的功能、出口信息、線程安全性、異常安全性、參數合法性等重要信息還是必須查閱文檔。

範本3:nFoo=nBar Vs foo=bar
匈法在這裡有什麼收益呢?我看不到。使用匈法的唯一好處是看代碼的人知道這裡發生了一個整型變量的複製動作,聽起來沒什麼問題,可以安心睡大覺了。如果他看到的是nFoo=szBar,可能會從美夢中驚醒。且慢,事情真的會是這樣嗎?我想首先被驚醒的應該是編譯器。另一方面,nFoo=nBar只是在語法上合法而已,看代碼的人真正關心的是語義的合法性,匈法對此毫無幫助。另一方面,一個優秀的書寫者會自覺地遵從一個法則:代碼最小組織單位中的臨時變量以一兩個為宜,

提T網件軟B'絡E$9

如果超過三個就應該重新組織。結合前述第一個法則,可以得出這樣的結論:易於理解的代碼本身就應該是易於理解的,這是代碼的內建高質量。好的命名規範對內建高質量的助益相當有限,而壞的命名規範對內建高質量的損害比人們想像的要大。
三 匈牙利命名法的實施

這裡要證明匈牙利命名法在C語言是難以實施的,在C++語言中是無法實施的。從邏輯上講,對匈法的收益做出否定的結論以後,再來論證匈法的可行性,是畫蛇添足。不過有鑑於小馬哥曾讓已射殺之敵死灰復燃,我還是再踏上一支腳為妙。

前面講過,匈法是類型系統的冗餘,所以實施匈法的關鍵是我們是否能夠精確地對類型系統進行複製。這取決於類型系統的複雜性。

先來看看C語言:

1.內置類型:int,char,float,double 複製為 n,ch,f,d?好像沒有什麼問題。不過誰來告訴我void應該怎麼表示?
2.組合類型:array,union,enum,struct 複製為 a,u,e,s?好像比較彆扭。
這裡的難點不是為主類型取名,而是為副類型取名。an表示整型數組?sfoo,sbar表示結構foo,結構bar?ausfoo表示聯合結構foo數組?累不累啊。
3.特殊類型:pointer。pointer在理論上應該是組合類型,供^_的C!]ZIcBuRT但是在C語言中可以認為是內置類型,因為C語言並沒有非常嚴格地區分不同的指針類型。下面開始表演:pausfoo表示聯合結構foo數組指針?ppp表示指針的指針的指針?

噩夢還沒有結束,再來看看類型系統更阿為豐富的C++語言:

1.class:如果說C語言中的struct還可以用stru搪塞過去的話,不要夢想用cls來搪塞C++中的class。嚴格地講,class 根本就並不是一個類型,而是創造類型的工具,在C++中,語言內置類型的數量和class創造的用戶自定義類型的數量相比完全可以忽略不計。 stdvectorFoo表示標準庫向量類型變量Foo?瘋狂的念頭。
2.命名空間:boostfilesystemiteratorFoo,表示boost空間filesystem子空間遍歷目錄類型變量Foo?程序員要崩潰了。
3.模板:你記得std::map<:string,std::string>類型的確切名字嗎?我是記不得了,好像超過255個字符,還是饒了我吧。
4. 模板參數:template const T& max(const T& a, const T& b, BinaryPredicate comp) 聰明的你,請用匈法為T命名。上帝在發笑。
5.類型修飾:static,extern,mutable,register,volatile,const,short,long,unsigned 噩夢加上修飾是什麼?還是噩夢。

你願意做鐐銬上的舞者嗎?