《《精编》Capb编码规范》由会员分享，可在线阅读，更多相关《《精编》Capb编码规范（26页珍藏版）》请在金锄头文库上搜索。
1、C#编码规范1 概述1.1 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。1.2 术语定义1.2.1 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写，文件命名也采用Pascal 大小写。例如： BackColor.cs1.2.2 Camel 大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor2 注释生成XML文档2.1 注释概述1 修改代码时，总是使代码周围的注释保持最新
2、。2 在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍。 3 避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。4 避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。5 避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。6 在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。7 如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码
3、，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。8 在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。 9 在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明 显的东西六周以后或许就不明显了。10 避免多余的或不适当的注释，如幽默的不主要的备注。11 使用注释来解释代码的意图。它们不应作为代码的联机翻译。 12 注释代码中不十分明显的任何内容。13 为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。14 对由循环和逻辑分支组成的代码使用注释。
4、这些是帮助源代码读者的主要方面。 15 在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。 16 用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。17 在所有的代码修改处加上修改标识的注释。18 为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。如 namespace Caiao.Procument.Web / namespace Caiao.Procument.Web2.2 文档型注释 该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别
5、人更好的了解代码的实现和接口。如/ /GetContextMenu 产生上下文菜单函数，并指定绑定的控件/ / 需要显示的右键菜单名称(逗号分隔)字串/ 右键菜单绑定的父控件名称/ 上下文菜单 ContextMenu / / public virtual ContextMenu GetContextMenu(string simpleContextMenuList,object userControl) /MyMethod is a method in the MyClass class./Heres how you could make a second paragraph in a des
6、cription./ /for information about output statements./ / / public static void MyMethod(int Int1) 2.3 类c注释 该类注释用于 1 不再使用的代码。 2 临时测试屏蔽某些代码。 用法 /*修改标识修改原因. . . (the source code )*/2.4 单行注释 该类注释用于1 方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例： / 注释语句 / private int number;或 / 注释语句 private int number; 2 方法内变量的声明或花括号后的注释
7、, 注释示例： if ( 1 = 1) / always true statement; / always true2.5 注释标签 标签用法作用c错误！超级链接引用无效。 text 希望将其指示为代码的文本。为您提供了一种将说明中的文本标记为代码的方法。使用 将多行指示为代码错误！超级链接引用无效。content段落文本。用于诸如 或 等标记内，使您得以将结构添加到文本中。错误！超级链接引用无效。name 为方法参数名。将此名称用单引号括起来 ( )。应当用于方法声明的注释中，以描述方法的一个参数。 name 要引用的参数名。将此名称用双引号括起来 ( )。 标记为您提供了一种指示词为参数的
8、方法。可以处理 XML 文件，从而用某种独特的方法格式化该参数。cref = member 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 ( ) 中。使您得以从文本内指定链接。使用 指示希望在“请参阅”一节中出现的文本。cref = member 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 ( ) 中使您得以指定希望在“请参阅”一节中出现的文本。使用 从文
9、本错误！超级链接引用无效。description 代码示例的说明。使用 标记可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 标记的使用。错误！超级链接引用无效。content 为希望将其标记为代码的文本。 记为您提供了一种将多行指示为代码的方法。使用 指示应将说明中的文本标记为代码错误！超级链接引用无效。此处description 为对象的摘要。应当用于描述类型成员。使用 以提供有关类型本身的信息。错误！超级链接引用无效。cref = member 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 me
10、mber 括在双引号 ( ) 中。description 说明。 标记使您可以指定类能够引发的异常。filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 ( )。 Tagpath：filename 中指向标记名的标记路径。将此路径括在单引号中 ( )。 name 注释前边的标记中的名称说明符；名称具有一个 id。 id 位于注释之前的标记的 id。将此 id 括在双引号中 ( )。 标记使您得以引用描述源代码中类型和成员的另一文件中的注释。这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。 标记使用 XML XPath 语法。有关自定义 使用的方法，请参阅 XPath 文档。 错误！超级链接引用无效。 错误！超级链接引用无效。 错误！超级链接引用无效。 错误！超级链接引用无效。 term 定义的项，该项将在 text 中定义。 description 目符号列表或编号列表中的项或者 term 的定义。 块用于定义表或定义列表中的标题行。定义表时，只需为标题中的项提供一个项。列表中的每一项用 块指定。创建定义列表时，既需要指定 term 也需要指定 text。但是，对于表、项目符号列表或编号列表，只需为
