淺析.NET開發(fā)過程中命名的數(shù)量和人稱
我們都明白命名的重要性,如果對(duì)命名不斷地關(guān)注,就需要考慮命名中的動(dòng)詞和名詞,特別的情況是動(dòng)詞的人稱和名詞的數(shù)量。
在.NET Framework的Guideline中,有專門一章討論了命名規(guī)范,包括大小寫、單詞的選擇等,卻沒有涉及到人稱和數(shù)量,下面來討論一下這兩方面的內(nèi)容。
名詞的數(shù)量
首先來看數(shù)量。名詞的單數(shù)和復(fù)數(shù)在語義上有著明顯的不同,為了提高可讀性,數(shù)量需要認(rèn)真地考慮。比如:
屬性(Property):System.Collections.Generic.Dictionary<TKey, TValue>中的Keys和Count是好的例子。字段與此類似; 方法名中的名詞:在JS中我們熟悉的getElementById和getElementsByTagName;
局部變量:與屬性相比,我們更可能遭遇的是局部變量。比如,用變量來表示一個(gè)人的名字,可以用string name; 如果是多個(gè)人的名字,則可以用List<string> names。
一般地,單數(shù)表達(dá)的語義是?(0或1);復(fù)數(shù)表達(dá)的語義是*(0、1或多個(gè))。關(guān)于名詞的數(shù)量很容易理解,相關(guān)的規(guī)則也容易遵循。
動(dòng)詞的人稱
下面再來考慮動(dòng)詞的人稱。在需要考慮命名的對(duì)象中,包括命名空間、類型、各種類型成員,只有方法是動(dòng)詞,語義上表示一個(gè)行為。關(guān)于它的人稱,來看一個(gè).NET Framework中的例子。在System.Collections.Generic.Stack<T>中,有一個(gè)Contains(T item)方法,對(duì)于這樣的代碼:
- if (theStack.Contains(1))
- {
- // Do something.
- }
讀起來像是:if the stack contains 1,比較通順。是不是所有方法都要這樣命名呢?沒有。另兩個(gè)方法Clear()和Push(T item)就不是如此,這個(gè)地方很讓人困惑。先寫成代碼看看
- theStack.Push(3);
- theStack.Clear();
嘗試像上面那樣作為一個(gè)句子來讀:the stack push 3; the stack clear,語法上不對(duì),看起來也應(yīng)該是第三人稱。這里我也不確定為何如此,只能嘗試來解釋下。考察多個(gè)集合類型和其它類型后發(fā)現(xiàn),所有使用第三人稱的地方都是謂詞函數(shù),除了上面的Contains(T item),還有Directory.Exists(string path),不知道這是不是其中的命名規(guī)則呢?
還要考慮注釋
一定程度上,注釋也算是一種代碼。一種是XML文檔注釋,在.NET Framework中,不管是對(duì)于類型還是類型成員,都使用了第三人稱,這一點(diǎn)我們也可以遵循。其它的普通注釋應(yīng)該也可以遵循這個(gè)規(guī)則。
原文鏈接:http://www.cnblogs.com/anderslly/archive/2011/01/26/name-conventions.html
【編輯推薦】