C# 代碼大小寫規(guī)范

C# 一般采用帕斯卡命名和駝峰命名，.NET類庫(kù)就是使用這種命名方法， 可見是微軟推薦的

• PasalCasing：標(biāo)識(shí)符的第一個(gè)單詞的字母大寫；
• camelCasing：標(biāo)識(shí)符的第一個(gè)單詞的字母小寫。

下表描述了不同類型標(biāo)識(shí)符的大小寫規(guī)則

這三個(gè)標(biāo)紅的是采用駝峰（Camel）命名法

其余的是帕斯卡（pascal）命名法

C#中的大小寫約定

許多命名約定都與標(biāo)識(shí)符的大小寫有關(guān)。值得注意的是，公共語(yǔ)言運(yùn)行庫(kù) (CLR) 支持區(qū)分大小寫和不區(qū)分大小寫的語(yǔ)言。本主題中描述的大小寫約定可幫助開發(fā)人員理解和使用庫(kù)。

大小寫樣式

下列術(shù)語(yǔ)描述了標(biāo)識(shí)符的不同大小寫形式。

Pascal 大小寫

將標(biāo)識(shí)符的首字母和后面連接的每個(gè)單詞的首字母都大寫?？梢詫?duì)三字符或更多字符的標(biāo)識(shí)符使用 Pascal 大小寫。

例如： BackColor

大小寫混合

標(biāo)識(shí)符的首字母小寫，而每個(gè)后面連接的單詞的首字母都大寫。

例如： backColor

大寫

標(biāo)識(shí)符中的所有字母都大寫。

例如： IO

標(biāo)識(shí)符的大小寫規(guī)則

如果標(biāo)識(shí)符由多個(gè)單詞組成，請(qǐng)不要在各單詞之間使用分隔符，如下劃線（“_”）或連字符（“-”）等。而應(yīng)使用大小寫來(lái)指示每個(gè)單詞的開頭。

下列準(zhǔn)則是用于標(biāo)識(shí)符的通用規(guī)則。

對(duì)于由多個(gè)單詞組成的所有公共成員、類型及命名空間名稱，要使用 Pascal 大小寫。

注意，這條規(guī)則不適用于實(shí)例字段。由于成員設(shè)計(jì)準(zhǔn)則中詳細(xì)說明的原因，不應(yīng)使用公共實(shí)例字段。

對(duì)參數(shù)名稱使用大小寫混合。

下表匯總了標(biāo)識(shí)符的大小寫規(guī)則，并提供了不同類型標(biāo)識(shí)符的示例。

首字母縮寫的大小寫規(guī)則

首字母縮寫詞是由術(shù)語(yǔ)或短語(yǔ)中各單詞的首字母構(gòu)成的單詞。例如，HTML 是 Hypertext Markup Language 的首字母縮寫。只有在公眾廣為認(rèn)知和理解的情況下，才應(yīng)在標(biāo)識(shí)符中使用首字母縮寫詞。首字母縮寫詞不同于縮寫詞，因?yàn)榭s寫詞是一個(gè)單詞的縮寫。例如，ID 是 identifier 的縮寫。通常情況下，庫(kù)名不應(yīng)使用縮寫詞。

可在標(biāo)識(shí)符中使用的兩個(gè)縮寫詞是 ID 和 OK。在采用 Pascal 大小寫格式的標(biāo)識(shí)符中，這兩個(gè)縮寫詞的大小寫形式應(yīng)分別為 Id 和 Ok。如果在采用大小寫混合格式的標(biāo)識(shí)符中將這兩個(gè)縮寫詞用作首個(gè)單詞，則它們的大小寫形式應(yīng)分別為 id 和 ok。

首字母縮寫詞的大小寫取決于首字母縮寫詞的長(zhǎng)度。所有首字母縮寫詞應(yīng)至少包含兩個(gè)字符。為了便于這些準(zhǔn)則的實(shí)施，如果某一首字母縮寫詞恰好包含兩個(gè)字符，則將其視為短型首字母縮寫詞。包含三個(gè)或三個(gè)以上字符的首字母縮寫詞為長(zhǎng)型首字母縮寫詞。 下列準(zhǔn)則為短型和長(zhǎng)型首字母縮寫詞指定了正確的大小寫規(guī)則。標(biāo)識(shí)符大小寫規(guī)則優(yōu)先于首字母縮寫詞大小寫規(guī)則。

兩字符首字母縮寫詞的兩個(gè)字符都要大寫，但當(dāng)首字母縮寫詞作為大小寫混合格式的標(biāo)識(shí)符的首個(gè)單詞時(shí)例外。

例如，名為 DBRate 的屬性是一個(gè)采用 Pascal 大小寫格式的標(biāo)識(shí)符，它使用短型首字母縮寫詞 (DB) 作為首個(gè)單詞。又如，名為 ioChannel 的參數(shù)是一個(gè)采用大小寫混合格式的標(biāo)識(shí)符，它使用短型首字母縮寫詞 (IO) 作為首個(gè)單詞。

包含三個(gè)或三個(gè)以上字符的首字母縮寫詞只有第一個(gè)字符大寫，但當(dāng)首字母縮寫詞作為大小寫混合格式的標(biāo)識(shí)符的首個(gè)單詞時(shí)例外。

例如，名為 XmlWriter 的類是一個(gè)采用 Pascal 大小寫格式的標(biāo)識(shí)符，它使用長(zhǎng)型首字母縮寫詞作為首個(gè)單詞。又如，名為 htmlReader 的參數(shù)是一個(gè)采用大小寫混合格式的標(biāo)識(shí)符，它使用長(zhǎng)型首字母縮寫詞作為首個(gè)單詞。

如果任何首字母縮寫詞位于采用大小寫混合格式的標(biāo)識(shí)符開頭，則無(wú)論該首字母縮寫詞的長(zhǎng)度如何，都不大寫其中的任何字符。

例如，名為 xmlStream 的參數(shù)是一個(gè)采用大小寫混合格式的標(biāo)識(shí)符，它使用長(zhǎng)型首字母縮寫詞 (xml) 作為首個(gè)單詞。又如，名為 dbServerName 的參數(shù)是一個(gè)采用大小寫混合格式的標(biāo)識(shí)符，它使用短型首字母縮寫詞 (db) 作為首個(gè)單詞。

復(fù)合詞和常用術(shù)語(yǔ)的大小寫規(guī)則

不要將所謂的緊湊格式復(fù)合詞中的每個(gè)單詞都大寫。這種復(fù)合詞是指寫作一個(gè)單詞的復(fù)合詞，如“endpoint”。

例如，hashtable 是一個(gè)緊湊格式的復(fù)合詞，應(yīng)將其視為一個(gè)單詞并相應(yīng)地確定大小寫。如果采用 Pascal 大小寫格式，則該復(fù)合詞為 Hashtable；如果采用大小寫混合格式，則該復(fù)合詞為 hashtable。若要確定某個(gè)單詞是否是緊湊格式的復(fù)合詞，請(qǐng)查閱最新的詞典。

下表列出了不是緊湊格式復(fù)合詞的一些常用術(shù)語(yǔ)。術(shù)語(yǔ)先以 Pascal 大小寫格式顯示，后面的括號(hào)中的是其大小寫混合格式。

• BitFlag (bitFlag)
• FileName (fileName)
• LogOff (logOff)
• LogOn (logOn)
• SignIn (signIn)
• SignOut (signOut)
• UserName (userName)
• WhiteSpace (whiteSpace)

區(qū)分大小寫

大小寫準(zhǔn)則只是為了使標(biāo)識(shí)符更易于閱讀和辨認(rèn)。不能將大小寫規(guī)則用作避免庫(kù)元素之間的命名沖突的手段。 不要假定所有編程語(yǔ)言都區(qū)分大小寫。事實(shí)并非如此。不能僅憑大小寫區(qū)分名稱。