c#编码规范(modified).docVIP

目 录 1 目的 1 2 范围 1 3 规范内容 1 3.1 代码格式 1 3.2 注释（Comment）规范 2 3.2.1 模块（类）注释规范 2 3.2.2 类属性注释规范 3 3.2.3 方法注释规范 3 3.2.4 代码间注释规范 3 3.3 变量（Variable）命名规范 4 3.3.1 程序文件(*.cs)中的变量命名规则 4 3.3.2 控件命名规则 8 3.4 常量命名规范 8 3.5 类（Class）命名规范 9 3.6 接口（Interface）命名规范 9 3.7 方法（Method）命名规范 9 3.8 命名空间（NameSpace）命名规范 10 1 目的 为了保证企业编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 2 范围 适用于企业所有基于.NET平台的软件开发工作。 3 规范内容 3.1 代码格式 所有的缩进为4个空格，使用VS.NET的默认设置。 在代码中垂直对齐左括号和右括号。 为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏。 当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 每一行上放置的语句避免超过一条。 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。 将大的复杂代码节分为较小的、易于理解的模块。 编写 SQL 语句时，对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例如： SELECT FirstName, LastName FROM Customers WHERE State = WA 3.2 注释（Comment）规范 注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释 3.2.1 模块（类）注释规范 模块开始必须以以下形式书写模块注释： ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ////summary 如果模块有修改，则每次修改必须添加以下注释： ///summary ///Log编号：Log编号,从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD ////summary 3.2.2 类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary ///属性说明 /// /summary 3.2.3 方法注释规范 在类的方法声明前必须以以下格式编写注释 /// summary /// 说明：对该方法的说明 /// /summary /// param name=参数名称参数说明/param /// returns ///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 /// /returns 3.2.4 代码间注释规范 代码间注释分为单行注释和多行注释： 单行注释： //单行注释 多行注释： /*多行注释1 多行注释2 多行注释3*/ 代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。 3.3 变量（Variable）命名规范 3.3.1 程序文件(*.cs)中的变量命名规则 程序中变量名称 = 变量的前缀 + 代表变量含意的英文单词或单词缩写。 1.类模块级的变量请用“m_”作前缀 public class Hello { private string m_Name; private DateTime m_Date; } 2.类的属性所对应的变量，采用属性名前加“m_”前缀的形式 public class Hello { private string m_Name; public string Name { get { return m_Name; } } } 3.方法的变量不使用前缀 public class Hello { void Say() { string SayWord; } } 4.方法的参数使用“p_”作为参数 public class Hello { void Say(string p_SayWord) { } } 补充说明： 针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为e； 如果有冲突的情况下，可以重复e，比如：ee。 例： Try { //your code