Team 專案開發”編碼規範”之二：代碼外觀

本文轉自：http://www.cnblogs.com/huyong/articles/1988420.html

 

 2.1 列寬

   代碼列寬控制在110字元左右。

    2.2 換行

      當運算式超出或即將超出規定的列寬，遵循以下規則進行換行

          1、在逗號後換行;

          2、在操作符前換行;

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

    2.3 縮排

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

   2.4 空行

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

 在代碼中，不能包含多個空行。       

     

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

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

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

         3、方法與方法之間。

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

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

         6、屬性與方法、屬性與欄位、方法與欄位之間。

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

 

 

    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、 左括弧“(” 不要緊靠關鍵字，中間用一個空格隔開。

      2、 左括弧“(” 與方法名之間不要添加任何空格。

      3、 沒有必要的話不要在返回語句中使用()。如

  

        if (condition)

 

            Array.Remove(1)

 

            return 1 

     2.7 花括弧 - {}

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

 

             if (condition)

             {

             }

 

             public int Add(int x, int y)

             {

             }

 

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

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

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

 

             if (somevalue == 1)

             {

                 somevalue = 2;

             }

 

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

 

               while (1)

               {

                   if  (valid)

                   {

                   }

                   else

                   {

                   } // if

                } // while