Capb编码规范.pdf

C#编码标准
1概述

1.1标准制定原那么

1方便代码的交流和维护。

2不碍事编码的效率，不与群众习惯冲突。

3使代码更美瞧、阅读更方便。

4使代码的逻辑更清楚、更易于理解。

1.2术语定义

1.2.1Pascal大小写

将标识符的首字母和后面连接的每个单词的首字母都大写。能够对三字符或更多字符的标识符使用Pascal

大小写，文件命名也采纳Pascal大小写。例如：

BackColor.cs

1.2.2Camel大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：

backColor
2注释生成XML文档

2.1注释概述

1修改代码时，总是使代码四面的注释维持最新。

2在每个例程的开始，提供标准的注释样本以指例如程的用途、假设和限制特别有关怀。注释样本

应该是解释它什么缘故存在和能够做什么的简短介绍。

3防止在代码行的末尾添加注释；行尾注释使代码更难阅读。只是在批注变量声明时，行尾注释是

适宜的；在这种情况下，将所有行尾注释在公共制表位处对齐。

4防止杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。

5防止在块注释的四面加上印刷框。如此瞧起来可能特别漂亮，然而难于维护。

6在部署公布之前，移除所有临时或无关的注释，以防止在日后的维护工作中产生混乱。

7要是需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释

难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，

但必须维持性能和可维护性之间的平衡。8在编写注释时使用完整的句子。注释应该讲明代码，而

不应该增加多义性。

9在编写代码时就注释，因为以后特别可能没有时刻如此做。另外，要是有时机复查已编写的代码，

在今天瞧来特别明显的东西六周以后或许就不明显了。

10防止多余的或不适当的注释，如幽默的不要紧的备注。

11使用注释来解释代码的意图。它们不应作为代码的联机翻译。

12注释代码中不十清楚显的任何内容。

13为了防止咨询题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。

14对由循环和逻辑分支组成的代码使用注释。这些是关怀源代码读者的要紧方面。

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

16用空白将注释同注释分隔符分开。在没有颜色提示的情况下查瞧注释时，如此做会使注释特别明显且轻
易被寻到。

17在所有的代码修改处加上修改标识的注释。

18为了是层次清楚，在闭合的右花括号后注释该闭合所对应的起点。如{

2.2文档型注释

该类注释采纳.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该

类注释，以便代码完成后直截了当生成代码文档，让不人更好的了解代码的实现和接口。如

///<summary>
///GetContextMenu产生上下文菜单函数，并指定绑定的控件
///</summary>
需要显示的右键菜单名称(逗号分隔)字串</param>
右键菜单绑定的父控件名称</param>
///<returns>上下文菜单ContextMenu</returns>
///<example></example>

///<remarks></remarks>

publicvirtualContextMenuGetContextMenu(stringsimpleContextMenuList,objectuserControl)

{

}
///<summary>MyMethodisamethodintheMyClassclass.
///<para>Here'showyoucouldmakeasecondparagraphinadescription.

///forinformationaboutoutputstatements.
///</para>

///</summary>
publicstaticvoidMyMethod(intInt1)
{
}

2.3类c注释

该类注释用于

1不再使用的代码。

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

用法
/*

[修改标识]

[修改缘故]

...(thesourcecode)

*/

2.4单行注释

该类注释用于

1方法内的代码注释。如变量的声明、代码或代码段的解释。注释例如：

//

//注释语句

//

privateintnumber;

或

//注释语句

privateintnumber;

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

if(1==1)//alwaystrue

{

statement;

}//alwaystrue