C#编程规范.docx

C#编程规范.docx

《C#编程规范.docx》由会员分享，可在线阅读，更多相关《C#编程规范.docx（34页珍藏版）》请在冰豆网上搜索。

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字符。

 VisualStudio.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（“sizeis“ + size + “\n”）;

4、语句中的表达式之间用空格隔开。

如

for （expr1; expr2; expr3）

2.6     花括号-{}

1、左花括号“{”放于关键字或方法名的下一行并与之对齐。

如

            if（condition）

            {

            }

            publicintAdd（intx,inty）

            {

            }

2、左花括号“{”要与相应的右花括号“}”对齐。

3、通常情况下左花括号“{”单独成行，不与任何语句并列一行。

4、if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。

如

            if（somevalue==1）

            {

                somevalue=2;

            }

5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。

如

              while 

（1）

              {

                  if （valid）

                  {

                  }//ifvalid

                  else

                  {

                  }//notvalid

               }//endforever

3      程序注释

3.1     注释概述

1）         修改代码时，总是使代码周围的注释保持最新。

2）           在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。

注释样本应该是解释它为什么存在和可以做什么的简短介绍.

3）           避免在代码行的末尾添加注释；行尾注释使代码更难阅读。

不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。

4）           避免杂乱的注释，如一整行星号。

而是应该使用空白将注释同代码分开。

5）           在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。

6）           如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。

尽一切可能不注释难以理解的代码，而应该重写它。

尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。

7）           在编写注释时使用完整的句子。

注释应该阐明代码，而不应该增加多义性。

8）           在编写代码时就注释，因为以后很可能没有时间这样做。

另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。

9）           避免多余的或不适当的注释，如幽默的不主要的备注。

10）       使用注释来解释代码的意图。

它们不应作为代码的联机翻译。

11）       注释代码中不十分明显的任何内容。

12）       为了防止问题反复出现，对错误修复和解决方法代码总是使用注释。

13）       对由循环和逻辑分支组成的代码使用注释。

这些是帮助源代码读者的主要方面。

14）       在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。

15）       在所有的代码修改处加上修改标示的注释。

16）       为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。

   namespaceLangchao.Procument.Web

{

}//namespaceLangchao.Procument.Web

3.2     文档型注释

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

如

///

  publicstaticvoidMyMethod（intInt1）

  {

          }

3.3     类c注释

该类注释用于

1）           不再使用的代码。

2）           临时测试屏蔽某些代码。

用法

        /*

[修改标识]

[修改原因]

...（thesourcecode）

*/

3.4     单行注释

该类注释用于

1）           方法内的代码注释。

如变量的声明、代码或代码段的解释。

注释示例：

         //

//注释语句

         //

        privateintnumber;

或

        //注释语句

        privateintnumber;

2）           方法内变量的声明或花括号后的注释,注释示例：

              if（1==1）   //alwaystrue

              {   

                 statement;

                }//alwaystrue

4      申明

4.1     每行声明数

一行只建议作一个声明，并按字母顺序排列。

如：

         intlevel;  //推荐

         intsize;   //推荐

         intx,y;   //不推荐

4.2     初始化

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

4.3     位置

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

如：

        voidMyMethod（）

         {

             intint1=0;        //beginningofmethodblock

if（condition）

{

                 intint2=0;    //beginningof"if"block

                 ...

             }

         }

不过也有一个例外：

               for（inti=0;i

               {

                   ...

               }

应避免不同层次间的变量重名，如：

           intcount;

           ...

voidMyMethod（）

{

               if（condition）

               {

                   intcount=0;    //避免

                    ...

                }

                ...

}

4.4     类和接口的声明

1）在方法名与其后的左括号间没有任何空格。

2） 左花括号“{”出现在声明的下行并与之对齐，单独成行。

3） 方法间用一个空行隔开。

4.5     字段的声明

不要使用是public或protected的实例字段。

如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。

考虑为字段提供get和set属性访问器，而不是使它们成为公共的。

get和set属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。

下面的代码示例阐释带有get和set属性访问器的私有实例字段的正确使用。

示例：

           publicclassControl:

Component

           {

              privateinthandle;

              public intHandle

              {

                 get

                 {

                    returnhandle;

                 }

              }

}

5      第五章　命名规范

5.1     命名概述

名称应该说明“什么”而不是“如何”。

通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。

例如，可以使用GetNextStudent（），而不是GetNextArrayElement（）。

命名原则是：

选择正确名称时的困难可能表明需要进一步分析或定义项的目的。

使名称足够长以便有一定的意义，并且足够短以避免冗长。

唯一名称在编程上仅用于将各项区分开。

表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。

其实从长变量名的负面作用三，因为Ctrl+C和Ctrl+V加上在VS中的智能感知，其负面追用已经很小。

最优秀的代码它本身就是注释。

作为一流的程序员。

并不仅仅实现功能，而是要让我们的代码更加优美，具备让他人维护或今后扩充的能力。

作为现在的业务系统，其门槛的准入水平已大大降低，实现功能上的需求已没有什么难度，但是高手和菜鸟的区别在于，高手的代码通俗易懂，在整个编码的过程中，不仅能考虑到性能、还会考虑代码可读性和维护性。

不过，请确保选择的名称符合适用语言的规则和标准。

以下几点是推荐的命名方法。

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。

可能的情况下，尽量不要使用原义数字或原义字符串，如

   Fori=1To7。

而是使用命名常数，如Fori=1ToNUM_DAYS_IN_WEEK以便于维护和理解。

8）文件名要和类名相同，一般情况下一个类一个文件。

5.2     大小写规则

下表汇总了大写规则，并提供了不同类型的标识符的示例。

标识符

大小写

示例

类

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     缩写

为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：

1）不要将缩写或缩略形式用作标识符名称的组成部分。

例如，使用GetWindow，而不要使用GetWin。

2）不要使用计算机领域中未被普遍接受的缩写。

3）在适当的时候，使用众所周知的缩写替换冗长的词组名称。

例如，用UI作为UserInterface缩写，用OLAP作为On-lineAnalyticalProcessing的缩写。

4）在使用缩写时，对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。

例如，使用HtmlButton或HTMLButton。

但是，应当大写仅有两个字符的缩写，如，System.IO，而不是System.Io。

5.4     命名空间

1）命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。

           CompanyName.TechnologyName[.Feature][.Design]

       例如：

        namespaceLangchao.Procurement            //浪潮公司的采购单管理系统

        namespaceLangchao.Procurement.DataRules  //浪潮公司的采购单管理系统的业务规则模块

2）命名空间使用Pascal大小写，用逗号分隔开。

3）TechnologyName指的是该项目的英文缩写，或软件名。

4） 命名空间和类不能使用同样的名字。

例如，有一个类被命名为Debug后，就不要再使用Debug作为一个名称空间名。

5.5     类

1）使用Pascal大小写。

2）用名词或名词短语命名类。

3）使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML   

4）不要使用类型前缀，如在类名称上对类使用C前缀。

例如，使用类名称FileStream，而不是

  CFileStream。

5）不要使用下划线字符（_）。

6、有时候需要提供以字母I开始的类名称，虽然该类不是接口。

只要I是作为类名称组成部分的整个单词的第一个字母，这便是适当的。

例如，类名称IdentityStore是适当的。

在适当的地方，使用复合单词命名派生的类。

派生类名称的第二个部分应当是基类的名称。

例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因ApplicationException是一种Exception。

请在应用该规则时进行合理的判断。

例如，Button对于从Control派生的类是适当的名称。

尽管按钮是一种控件，但是将Control作为类名称的一部分将使名称不必要地加长。

           publicclassFileStream

           publicclassButton

publicclassString

5.6     接口

以下规则概述接口的命名指南：

1）用名词或名词短语，或者描述行为的形容词命名接口。

例如，接口名称IComponent使用描述性名词。

接口名称ICustomAttributeProvider使用名词短语。

名称IPersistable使用形容词。

2）使用Pascal大小写。

3）少用缩写。

4）给接口名称加上字母I前缀，以指示该类型为接口。

在定义类/接口对（其中类是接口的标准实现）时使用相似的名称。

两个名称的区别应该只是接口名称上有字母I前缀。

5）不要使用下划线字符（_）。

6） 当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。

两个名称的不同之处只是接口名前有一个I前缀。

以下是正确命名的接口的示例。

               publicinterfaceIServiceProvider

               publicinterfaceIFormatable

以下代码示例阐释如何定义IComponent接口及其标准实现Component类。

              publicinterfaceIComponent

              {

                  //Implementationcodegoeshere.

              }

              publicclassComponent:

IComponent