团队项目开发"编码规范"之二：代码外观

团队项目开发"编码规范"之二：代码外观 

发布日期：2011年3月18日星期三作者:EricHu

  勤能补拙、笨鸟先飞。

 

 

    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