C#程式設計規範

C#程式設計規範

本文是基于網上傳得比較廣泛的“東軟c#程式設計規範”為藍本，

1      概述

1.1     規範制定原則

1)     友善代碼的交流和維護。

2)     不影響編碼的效率，不與大衆習慣沖突。

3)     使代碼更美觀、閱讀更友善。

4)     使代碼的邏輯更清晰、更易于了解。

1.2     術語定義

1)   Pascal大小寫

     将辨別符的首字母和後面連接配接的每個單詞的首字母都大寫。可以對三字元或更多字元的辨別符使用Pascal大小寫。例

BackColor

2)   Camel大小寫

     辨別符的首字母小寫，而每個後面連接配接的單詞的首字母都大寫。例如：

    backColor

1.3     檔案命名組織

1)   檔案名遵從Pascal命名法，無特殊情況，擴充名小寫。

2)     使用統一而又通用的檔案擴充名：C#類 .cs

1)   在每個檔案頭必須包含以下注釋說明

           /*----------------------------------------------------------------

           // Copyright (C)公司名稱

           //版權所有。

           //

           //檔案名：

           //檔案功能描述：

           //建立辨別：

           //修改辨別：

           //修改描述：

//----------------------------------------------------------------*/

2)   檔案功能描述隻需簡述，具體詳情在類的注釋中描述。

3)   建立辨別和修改辨別由建立或修改人員的拼音或英文名加日期組成。如：

   姚明20040408

4)   一天内有多個修改的隻需做一個在注釋說明中做一個修改辨別就夠了。

5)   在所有的代碼修改處加上修改辨別的注釋。

2      代碼外觀

2.1     列寬

   代碼列寬控制在110字元左右，原則上不超過屏寬。

2.2     換行

     當表達式超出或即将超出規定的列寬，遵循以下規則進行換行：

         1、在逗号，括号後換行。

         2、 在操作符前換行。

         3、規則1優先于規則2。

    當以上規則會導緻代碼混亂的時候自己采取更靈活的換行規則。    

2.3     縮進

    縮進應該是每行一個Tab(4個空格)，不要在代碼中使用Tab字元。

 Visual Studio.Net設定：工具->選項->文本編輯器->C#->制表符->插入空格

2.4     空行

空行是為了将邏輯上相關聯的代碼分塊，以便提高代碼的可閱讀性。

在以下情況下使用兩個空行：

  1、接口和類的定義之間。

  2、枚舉和類的定義之間。

  3、類與類的定義之間。     

在以下情況下使用一個空行：

1、方法與方法、屬性與屬性之間。

2、方法中變量聲明與語句之間。

3、方法與方法之間。

4、方法中不同的邏輯塊之間。

5、方法中的傳回語句與其他的語句之間。

6、屬性與方法、屬性與字段、方法與字段之間。

7、注釋與它注釋的語句間不空行，但與其他的語句間空一行。

8、檔案之中不得存在無規則的空行，比如說連續十個空行。空行是為了将邏輯上相關聯的代碼分塊，以便提高代碼的可閱讀性。

2.5     空格

在以下情況中要使用到空格：

1、 關鍵字和左括符 “(” 應該用空格隔開。如

          while (true)   

       注意在方法名和左括符 “(”之間不要使用空格，這樣有助于辨認代碼中的方法調用與關鍵字。

2、  多個參數用逗号隔開，每個逗号後都應加一個空格。

3、  除了.之外，所有的二進制操作符都應用空格與它們的操作數隔開。一進制操作符、++及--與操作   數間不需要空格。如

          a += c + d;

          a = (a + b)  /  (c * d);

           while (d++ = s++)

           {

                   n++;

           }

           PrintSize(“size is“ + size + “\n”);

4、 語句中的表達式之間用空格隔開。如

for (expr1; expr2; expr3)

2.6     花括号- {}

1、左花括号 “{” 放于關鍵字或方法名的下一行并與之對齊。如

            if (condition)

            {

            }

            public int Add(int x, int y)

2、左花括号 “{” 要與相應的右花括号 “}”對齊。

3、 通常情況下左花括号 “{”單獨成行，不與任何語句并列一行。

4、 if、while、do語句後一定要使用{}，即使{}号中為空或隻有一條語句。如

            if (somevalue == 1)

                somevalue = 2;

5、右花括号“}”後建議加一個注釋以便于友善的找到與之相應的{。如

              while (1)

作者：水木