下載 

本文是基於網上傳得比較廣泛的“東軟c#程式設計規範”為藍本，加入了我自己認為有用的一些規範整理出來的

作者：方明

1       概述

1.1      規範制定原則

1)      方便程式碼的交流和維護。

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

3)      使程式碼更美觀、閱讀更方便。

4)      使程式碼的邏輯更清晰、更易於理解。

1.2      術語定義

1)    Pascal 大小寫

      將識別符號的首字母和後面連線的每個單詞的首字母都大寫。可以對三字元或更多字元的識別符號使用Pascal 大小寫。例

BackColor

2)    Camel 大小寫

      識別符號的首字母小寫，而每個後面連線的單詞的首字母都大寫。例如：

     backColor

1.3      檔案命名組織

1.3.1   檔案命名

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

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

1.3.2   檔案註釋

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)

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/12639172/viewspace-448578/，如需轉載，請註明出處，否則將追究法律責任。