编码规范(C#).doc

软件开发标准技术文档(C#)编码规范SeanOuyang软件技术文档2012年修改记录序号版本号拟制人/修改人拟制/修改日期更改备注11.0seanouyang2012-07-10初稿(来源于网络)21.1seanouyang2012-07-14修改目录一、前言5二、代码外观62.1列宽62.2换行62.3缩进62.4空行62.5空格62.6括号72.7花括号7三、程序注释83.1注释概述83.2文档型注释83.3类c注释93.4单行注释93.5注释标签9四、申明114.1 每行声明数114.2初始化114.3位置114.4类和接口的声明114.5字段的声明12五、命名规范135.1命名概述135.2大小写规则135.3缩写145.4命名空间145.5类155.6接口155.7属性 (Attribute)165.8枚举 (Enum)165.9参数165.10方法175.11属性 (property)175.12事件185.13常量 (const)195.14字段195.15静态字段205.16集合205.17措词20六、语句226.1每行一个语句226.2复合语句226.3 return 语句226.4if、 if-else、if else-if 语句226.4 for、foreach 语句236.5while 语句236.6switch - case 语句236.7 try - catch 语句246.8 using 块语句24七、控件命名规则257.1命名方法257.2主要控件名简写对照表25八、其他268.1表达式268.2类型转换26九、相关约定279.1大小写约定279.2通用命名约定299.3类、结构和接口的名称309.4类成员的名称309.5枚举的名称32十、良好的编程习惯33一、前言软件的长期价值直接源于其编码质量。在它的整个生命周期里，一个程序可能会被许多人阅读或修改。如果一个程序可以清晰的展现出它的结构和特征，那就能减少在以后对其进行修改时出错的可能性。规范制定原则1 方便代码的交流和维护。2 不影响编码的效率，不与大众习惯冲突。3 使代码更美观、阅读更方便。4 使代码的逻辑更清晰、更易于理解。二、代码外观2.1列宽代码列宽控制在110字符左右。2.2换行当表达式超出或即将超出规定的列宽，遵循以下规则进行换行1、在逗号后换行。2、在操作符前换行。3、规则1优先于规则2。当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。2.3缩进缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。Visual Studio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格2.4空行空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。在以下情况下使用两个空行1、接口和类的定义之间。2、枚举和类的定义之间。3、类与类的定义之间。 在以下情况下使用一个空行1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。5、方法中的返回语句与其他的语句之间。6、属性与方法、属性与字段、方法与字段之间。7、注释与它注释的语句间不空行，但与其他的语句间空一行。2.5空格在以下情况中要使用到空格1、关键字和左括符 “(” 应该用空格隔开。如while (true) 注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。 2、多个参数用逗号隔开，每个逗号后都应加一个空格。3、除了.之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、及-与操作数间不需要空格。如a += c + d;a = (a + b) / (c * d);while (d+ = s+) n+;PrintSize(“size is “ + size + “n”);4、 语句中的表达式之间用空格隔开。如for (expr1; expr2; expr3)2.6括号1、左括号“(” 不要紧靠关键字，中间用一个空格隔开。2、左括号“(” 与方法名之间不要添加任何空格。3、没有必要的话不要在返回语句中使用()。如 if (condition) Array.Remove(1) return 1 2.7花括号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 / end forever三、程序注释3.1注释概述1、修改代码时，总是使代码周围的注释保持最新。2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。 4 、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。 5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。6 、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。7 、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。8 、在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。 9 、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。10 、避免多余的或不适当的注释，如幽默的不主要的备注。11、 使用注释来解释代码的意图。它们不应作为代码的联机翻译。 12、 注释代码中不十分明显的任何内容。13 、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。14 、对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。 15 、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。 16 、用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。17 、在所有的代码修改处加上修改标识的注释。18 、为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。namespace Langchao.Procument.Web / namespace Langchao.Procument.Web3.2文档型注释 该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档让别人更好的了解代码的实现和接口。如/MyMethod is a method in the MyClass class./Heres how you could make a second paragraph in a description./ /for information about output statements./public static void MyMethod(int Int1)3.3类c注释该类注释用于1 不再使用的代码。2 临时测试屏蔽某些代码。用法/*修改标识修改原因. . . (the source code )*/3.4单行注释该类注释用于1 方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例：/ 注释语句private int number;2 方法内变量的声明或花括号后的注释, 注释示例： if ( 1 = 1) / always true statement; / always true3.5注释标签 标签用法作用text text 希望将其指示为代码的文本。为您提供了一种将说明中的文本标记为代码的方法。使用 将多行指示为代码contentcontent段落文本。用于诸如 或 等标记内，使您得以将结构添加到文本中。descriptionname 为方法参数名。应当用于方法声明的注释中，以描述方法的一个参数。name 要引用的参数名。 标记为您提供了一种指示词为参数的方法。可以处理 XML 文件，从而用某种独特的方法格式化该参数。cref = member 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。使您得以从文本内指定链接。使用 指示希望在“请参阅”一节中出现的文本。cref = member 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。使您得以指定希望在“请参阅”一节中出现的文本。使用 从文本descriptiondescription 代码示例的说明。使用 标记可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 标记的使用。contentcontent 为希望将其标记为代码的文本。记为您提供了一种将多行指示为代码的方法。使用 指示应将说明中的文本标记为代码description此处description 为对象的摘要。应当用于描述类型成员。使用 以提供有关类型本身的信息。descriptioncref = member 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将 member 转换为输出 XML 中的规范化元素名 标记使您可以指定类能够引发的异常。filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 ( )。 Tagpath：filename 中指向标记名的标记路径。将此路径括在单引号中 ( )。 name 注释前边的标记中的名称说明符；名称具有一个 id。 标记使您得以引用描述源代码中类型和成员的另一文件中的注释。这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。 标记使用 XML XPath 语法。有关自定义 使用的方法，请参阅 XPath 文档。 term description term description term 定义的项，该项将在 text 中定义。 description 目符号列表或编号列表中的项或者 term 的定义。 块用于定义表或定义列表中的标题行。定义表时，只需为标题中的项提供一个项。列表中的每一项用 块指定。创建定义列表时，既需要指定 term 也需要指定 text。但是，对于表、项目符号列表或编号列表，只需为 text 提供一个项。列表或表所拥有的 块数可以根据需要而定。descriptioncref = member 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 ( ) 中。 description 成员的访问的说明。 标记使您得以将成员的访问记入文档。System.Security.PermissionSet 使您得以指定对成员的访问。descriptiondescription 成员的说明。 标记是可以指定有关类或其他类型的概述信息的位置。 是可以描述该类型的成员的位置。descriptiondescription 返回值的说明。 标记应当用于方法声明的注释，以描述返回值。property-descriptionproperty-description 属性的说明。 标记使您得以描述属性。请注意，当在 Visual Studio .NET 开发环境中通过代码向导添加属性时，它将会为新属性添加 标记。然后，应该手动添加 标记以描述该属性所表示的值四、申明4.1 每行声明数一行只建议作一个声明，并按字母顺序排列。如int level; /推荐int size; /推荐int x, y; /不推荐4.2初始化建议在变量声明时就对其做初始化。 4.3位置变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如void MyMethod() int int1 = 0; / beginning of method blockif (condition) int int2 = 0; / beginning of if block . 不过也有一个例外 for (int i = 0; i maxLoops; i+) . 应避免不同层次间的变量重名，如int count; .void MyMethod() if (condition) int count = 0; / 避免 . .4.4类和接口的声明1 在方法名与其后的左括号间没有任何空格。2 左花括号 “” 出现在声明的下行并与之对齐，单独成行。3 方法间用一个空行隔开。 4.5字段的声明不要使用是 public 或 protected 的实例字段。如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。 get 和 set 属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释带有get 和 set 属性访问器的私有实例字段的正确使用。 示例：public class Control: Componentprivate int handle;public int Handleget return handle; 五、命名规范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.IOSystem.Web.UI下表汇总了大写规则，并提供了不同类型的标识符的示例。标识符大小写示例类PascalAppDomain枚举类型PascalErrorLevel枚举值PascalFatalError事件PascalValueChange异常类PascalWebException注意总是以Exception后缀结尾。只读的静态字段PascalRedValue接口PascalIDisposable 注意 总是以 I 前缀开始。方法PascalToString命名空间PascalSystem.Drawing属性PascalBackColor公共实例字段PascalRedValue 注意 很少使用。属性优于使用公共实例字段。受保护的实例字段CamelredValue 注意 很少使用。属性优于使用受保护的实例字段。私有的实例字段CamelredValue参数CameltypeName方法内的变量CamelbackColor5.3缩写为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则： 1 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。 2 不要使用计算机领域中未被普遍接受的缩写。 3 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩写，用 OLAP 作为 On-line Analytical Processing 的缩写。 4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。5 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel 大小写，虽然这和单词的标准缩写相冲突。5.4命名空间1、命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。CompanyName.TechnologyName.Feature.Design例如：namespace Langchao.Procurement /采购单管理系统namespace Langchao.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 作为类名称的一部分将使名称不必要地加长。public class FileStreampublic class Buttonpublic class String 5.6接口以下规则概述接口的命名指南： 1、用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称 IComponent 使用描述性名词。接口名称 ICustomAttributeProvide使用名词短语。名称 IPersistable 使用形容词。 2、使用 Pascal 大小写。3、少用缩写。4、接口名称加上字母I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接口的标准实现）时使用相似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。 5、不要使用下划线字符 (_)。 6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处只是接口名前有一个I前缀。以下是正确命名的接口的示例。public interface IServiceProviderpublic interface IFormatable以下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。public interface IComponent / Implementation code goes here.public class Component: IComponent / Implementation code goes here.5.7属性 (Attribute)应该总是将后缀 Attribute 添加到自定义属性类。以下是正确命名的属性类的示例。public class ObsoleteAttribute 5.8枚举 (Enum)枚举 (Enum) 值类型从 Enum 类继承。以下规则概述枚举的命名指南： 1 对于 Enum 类型和值名称使用 Pascal 大小写。 2 少用缩写。 3 不要在 Enum 类型名称上使用 Enum 后缀。 4 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。 5 总是将 FlagsAttribute 添加到位域 Enum 类型。 5.9参数以下规则概述参数的命名指南： 1、使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。 2、对参数名称使用 Camel 大小写。 3、 使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此， 通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。 4、不要使用保留的参数。保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。 5、不要给参数名称加匈牙利语类型表示法的前缀。 以下是正确命名的参数的示例。Type GetType(string typeName)string Format(string format, args() As object) 5.10方法以下规则概述方法的命名指南： 1 使用动词或动词短语命名方法。 2 使用 Pascal 大小写。 3 以下是正确命名的方法的实例。 RemoveAll() GetCharArray()Invoke()5.11属性 (property)以下规则概述属性的命名指南： 1 使用名词或名词短语命名属性。 2 使用 Pascal 大小写。 3 不要使用匈牙利语表示法。 4 考虑用与属性的基础类型相同的名称创建属性。例如，如果声明名为 Color 的属性，则属性的类型同样应该是 Color。请参阅本主题中后面的示例。 以下代码示例阐释正确的属性命名。public class SampleClass public Color BackColor / Code for Get and Set accessors goes here. 以下代码示例阐释提供其名称与类型相同的属性。public enum Color/ Insert code for Enum here.public class Controlpublic Color Colorget/ Insert code here.set/ Insert code here.以下代码示例不正确，原因是 Color 属性是 Integer 类型的。public enum Color/ Insert code for Enum here. public class Controlpublic int Color/ Insert code here 在不正确的示例中，不可能引用 Color 枚举的成员。Color.Xxx 将被解释为访问一个成员，该成员首先获取 Color 属性（ C# 中为 int 类型）的值，然后再访问该值的某个成员（该成员必须是 System.Int32 的实例成员）。5.12事件以下规则概述事件的命名指南： 1、对事件处理程序名称使用 EventHandler 后缀。 2、指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参数始终是object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。 3、用 EventArgs 后缀命名事件参数类。 4、考虑用动词命名事件。 5、使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事件后。例如，可以取消的 Close 事件应当具有 Closing 事件和 Closed 事件。不要使用BeforeXxx/AfterXxx 命名模式。 6、不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。 7、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为 OnXxx）。此方法只应具有事件参数 e，因为发送方总是类型的实例。 以下示例阐释具有适当名称和参数的事件处理程序。public delegate void MouseEventHandler(object sender, MouseEventArgs e);以下示例阐释正确命名的事件参数类。public class MouseEventArgs : EventArgsint x;int y;public MouseEventArgs(int x, int y)this.x = x;this.y = ypublic int Xgetreturn x;public int Ygetreturn y;5.13常量 (const)以下规则概述常量的命名指南： 所有单词大写，多个单词之间用 _ 隔开。 如public const string PAGE_TITLE = Welcome; 5.14字段以下规则概述字段的命名指南： 1、private、protected 使用 Camel 大小写。2、public 使用 Pascal 大小写。3、拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。字段名称不要使用大写字母。下面是正确命名的字段的示例。 class SampleClass string url; string destinationUrl;4、不要对字段名使用匈牙利语表示法。好的名称描述语义，而非类型。 5、不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来区分静态和非静态字段。例如，应用 g_ 或 s_ 前缀是不正确的。 6、对预定义对象实例使用公共静态只读字段。如果存在对象的预定义实例，则将它们声明为对象本身的公共静态只读字段。使用 Pascal 大小写，原因是字段是公共的。下面的代码示例阐释公共静态只读字段的正确使用。 public struct Colorpublic static readonly Color Red = new Color(0x0000FF);public Color(int rgb)/ Insert code here.public Color(byte r, byte g, byte b)/ Insert code here.public byte RedValue get return Color; 5.15静态字段以下规则概述静态字段的命名指南： 1、使用名词、名词短语或者名词的缩写命名静态字段。 2、使用 Pascal 大小写。 3、对静态字段名称使用匈牙利语表示法前缀。 4、建议尽可能使用静态属性而不是公共静态字段。 5.16集合集合是一组组合在一起的类似的类型化对象，如哈希表、查询、堆栈、字典和列表，集合的命名建议用复数。5.17措词避免使用与常用的 .NET 框架命名空间重复的类名称。例如，不要将以下任何名称用作类名称：System、Collections、Forms 或 UI。有关 .NET 框架命名空间的列表，请参阅类库。另外，避免使用和以下关