C#代码编写规范

命名规范

命名规范主要涉及命名空间、类型、接口、属性、方法、变量等相关命名。它在编写代码中起到很重要的作用，不仅可以清晰的表达出程序规划的核心，还可以达到让人“望文知意”的效果。虽然不遵循命名规范程序也可以运行，但是使用命名规范可以很直观的了解代码所代表的含义。

1. 字母大小写约定
   (1) Pascal风格：将标识符的首字母和后面连接的每个单词的首字母都大写。
   (2) Camel风格：标识符的首字母小写，而每个后面连接的单词的首字母都大写。
   (3) 大写规范：标识符中的所有字母都大写。
2. 区分大小写
   (1) 不要使用要求区分大小写的名称。
   (2) 不要创建仅是名称大小写有区别的两个命名空间。
3. 缩写
   为了避免混淆和保证跨语言交互操作，请遵循有关缩写的使用规则：
   (1) 不要将缩写或缩略形式用作标识符名称的组成部分。
   (2) 不要使用计算机领域中未被普遍接受的缩写

namespace的命名规范

namespace的命名规范说明如下：
(1) 给命名空间名称加上公司名称或者其他知名商标的前缀可以避免两个已经发布的命名空间名称相同的可能性。
(2) 在第二级分层名称上使用稳定的、公认的技术名称。将组织层次架构用作命名空间层次架构的基础。命名一个命名空间，该命名空间包含为具有.Design后缀的基命名空间提供设计时功能的类型。
(3) 嵌套的命名空间应当在包含它的命名空间中的类型上有依赖项。
(4) 应当对命名空间使用Pascal风格书写，并用句点分隔逻辑组件，如Microsoft.Office.PowerPoint中所示。如果用户的商标使用非传统的大小写，请遵循商标所定义的大小写，即使它与规定的Pascal大小写相背离。
(5) 如果在语义上适当，可以使用复数命名空间名称。
(6) 不要为命名空间和类使用相同的名称。例如，不要既提供Debug命名空间也提供Debug类。最后，请注意命名空间名称不必非得与程序集名称相似。

类的命名规范

以下规则概述命名类的规范：
(1) 使用名词或名词短语命名类。
(2) 使用Pascal风格。
(3) 少用缩写。
(4) 不要使用类型前缀，如在类名称上对类使用C前缀。例如，使用类名称FileStream，而不是CFileStream。
(5) 不要使用下划线字符(_)。
(6) 有时候需要提供以字母I开始的类名称，虽然该类不是接口。只要I是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称IdentityStore就是适当的。
(7) 在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因是ApplicationException是一种Exception。

接口的命名规范

以下规则概述接口的命名规范：
(1) 用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称IComponent使用描述性名词。接口名称ICustomAttributeProvider使用名词短语。名称IPersistable使用形容词。
(2) 使用Pascal大小写。
(3) 少用缩写。
(4) 给接口名称加上字母I前缀，以指示该类型为接口。
(5) 在定义类/接口(其中类是接口的标准实现)时使用相似的名称。两个名称的区别应该只是接口名称上有字母I前缀。
(6) 不要使用下划线字符 (_)。

方法的命名规范

以下规则概述方法的命名规范：
(1) 使用动词或动词短语命名方法。
(2) 使用Pascal大小写。
以下是正确命名的方法的实例。
RemoveAll()
GetCharArray()
Invoke()

不同变量使用前缀区分对于private的变量，使用以下约定。

(1) 成员变量应该在开始就被声明,并集中放在class的开始位置。
(2) 请使用m，s前缀来区分成员变量和静态成员变量。对于局部变量不适用任何前缀。
例如：

 class VarUsing
   {
       private static bool s_isOK=false;   //静态变量s_isOK
       private bool m_isOK=false;    //成员变量m_isOK
       public void Test()
       {
           bool is_OK=false;            //局部变量is_OK
       }
   }

注释规范

注释用来对编写的代码进行说明，包括功能说明以及实现说明，这样可以大大的提高程序的可读性，另外规范的注释还可以通过工具来生成相应的API文档，C#的注释规范有以下几种：

1. 类注释规范
2. 类属性注释规范
3. 方法注释规范
4. 代码间注释规范
   注释说明：
   (1) 代码中遇到语句块时必须添加注释，并且添加的注释必须能够说明此语句块的作用和实现手段。
   (2) 尽量多点注释，就算能一目了然的命名最好也顺便写一些注释，方便以后接收的人能更容易理解程序。
   (3) 如果因为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和更多的注释。

布局规范

布局规范的目的是使代码变得整洁，提高代码可读性，其主要规范有：

1. 列宽 ：每行代码列宽应该控制在110字符左右。
2. 换行 ：当表达式超出或即将超出规定的列宽，遵循以下规则进行换行：
   (1) 在逗号后换行。(2) 在操作符前换行。
3. 缩进：缩进应该是每行一个Tab键或者4个空格。左右花括号必须独自一行，括号内容为空时除外
4. 空行：空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
5. 空格：(1) 关键字和左括符“(”应该用空格隔开。(2) 多个参数用逗号隔开，每个逗号后都应加一个空格。(3) 除了“.”之外，所有的二元操作符都应用空格与它们的操作数隔开。
6. 括号“()”：(1) 左括号“(”不要紧靠关键字，中间用一个空格隔开。(2) 左括号“(”与方法名之间不要添加任何空格。(3) 没有必要的话不要在返回语句中使用括号。