项目撰写规范

第一章   概述

规范制定原则

 1 方便代码的交流和维护。
   2 不影响编码的效率，不与大众习惯冲突。
   3 使代码更美观、阅读更方便。
   4 使代码的逻辑更清晰、更易于理解。
 

术语定义

Pascal 大小写

      将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：
               BackColor

Camel 大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：
                backColor
第二章   代码外观

2.1    列宽

    代码列宽控制在110字符左右。

2.2    换行

      当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
          1、在逗号后换行。
          2、在操作符前换行。
          3、规则1优先于规则2。
      当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。

2.3    缩进

     缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。

2.4    空行

空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
     在以下情况下使用两个空行
    1、接口和类的定义之间。
    2、枚举和类的定义之间。
    3、类与类的定义之间。       
    在以下情况下使用一个空行
         1、方法与方法、属性与属性之间。
         2、方法中变量声明与语句之间。
         3、方法与方法之间。
         4、方法中不同的逻辑块之间。
      　 5、方法中的返回语句与其他的语句之间。
         6、属性与方法、属性与字段、方法与字段之间。
         7、注释与它注释的语句间不空行，但与其他的语句间空一行。

2.5    花括号 - {}

       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)
                   {
                   } // if valid
                   else
                   {
                   } // not valid
                } // end forever
第三章 程序注释

3.1    注释概述

1、修改代码时，总是使代码周围的注释保持最新。
2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.
3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的。
4 、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。
5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。
6 、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
7 、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。
8 、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。
9、 使用注释来解释代码的意图。它们不应作为代码的联机翻译。
10、 注释代码中不十分明显的任何内容。

3.2    文档型注释

采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用XML注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。
第四章　申明

4.1    每行声明数

一行只建议作一个声明，并按字母顺序排列。如
          int level;   //推荐
          int size;    //推荐
          int x, y;    //不推荐

4.2   初始化

      建议在变量声明时就对其做初始化。 

4.3   位置

      变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。

4.4   字段的声明

不要使用是 public 或 protected 的实例字段。
第五章    命名规范

5.1   命名概述

名称应该说明“什么”而不是“如何”。 例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称，如方面名 AnalyzeThis()，或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的，如 Book.BookTitle。而是应该使用 Book.Title。
3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。
4、在变量名中使用互补对，如 min/max、begin/end 和 open/close。
5、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。
6、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如 documentFormatType。
7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 可能的情况下，尽量不要使用原义数字或原义字符串，如：For i = 1 To 7。而是使用命名常数，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。

5.2    大小写规则

标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：
System.IO
System.Web.UI
下表汇总了大写规则，并提供了不同类型的标识符的示例。

标识符	大小写	示例
类	Pascal	AppDomain
枚举类型	Pascal	ErrorLevel
枚举值	Pascal	FatalError
事件	Pascal	ValueChange
异常类	Pascal	WebException 注意 总是以 Exception 后缀结尾。
只读的静态字段	Pascal	RedValue
接口	Pascal	IDisposable 注意 总是以 I 前缀开始。
方法	Pascal	ToString
命名空间	Pascal	System.Drawing
属性	Pascal	BackColor
公共实例字段	Pascal	RedValue 注意 很少使用。属性优于使用公共实例字段。
受保护的实例字段	Camel	redValue 注意 很少使用。属性优于使用受保护的实例字段。
私有的实例字段	Camel	redValue
参数	Camel	typeName
方法内的变量	Camel	backColor

 

5.3    常量 (const)

        以下规则概述常量的命名指南：
        所有单词大写，多个单词之间用 "_" 隔开。 如
                 public const string PAGE_TITLE = "Welcome";
第六章　语句

6.1    每行一个语句

         每行最多包含一个语句。如
             a++;       //推荐
             b--;       //推荐
a++; b--;  //不推荐
6.2   return 语句
return语句中不使用括号，除非它能使返回值更加清晰。如
              return;
              return myDisk.size();
              return (size ? size : defaultSize);
 
 
 
第七章  控件命名规则

7.1    命名方法

控件名简写+英文描述，英文描述首字母大写

7.2    主要控件名简写对照表

控件名                       简写             控件名                            简写
Label                         lbl               TextBox                              txt
Button                         btn              LinkButton                      lnkbtn
ImageButton             imgbtn           Combobox                    cmb
ListBox                        lst               DataGridView                  dgv
CheckBox                      chk            CheckBoxList                      chkls         
RadioButton                 rdo            RadioButtonList                  rdolt          
Image                            img           Panel                              pnl           
CalenderDate              cldd