C_编程规范.doc

C#编码规范 注:C－创建;　M－修改; D－删除; A－添加 1 目的 为了保证企业编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护 - 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 - 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 - 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。 2 范围 适用于企业所有基于C#.NET平台的软件开发工作。 3 规范内容 3.1 文件规范 3.1.1 文件命名与类名名称相同 3.1.2 文件内容格式 开头注释 引用 命名空间 类体 变量(代理事件)：用#region 变量………#endregion包括 属性：用#region属性………#endregion包括 构造： 方法(事件的实现)：用#region方法………#endregion包括 3.2 代码格式 所有的缩进为4个空格，以空格代替Tab 。选中”插入空格(P)” 在代码中垂直对齐左括号和右括号。 if(x==0) { Response.Write(用户编号必须输入！); } 不允许以下情况： if(x==0) { Response.Write(用户编号必须输入！); } 或者： if(x==0){ Response.Write(用户编号必须输入！);} 为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏 当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 每一行上放置的语句避免超过一条。 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。 例： int j = i + k; 而不应写为 int j=i+k; 将大的复杂代码节分为较小的、易于理解的模块。 编写 SQL 语句时，对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例如： SELECT FirstName, LastName FROM Customers WHERE State = WA 3.3 注释（Comment）规范 注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释 3.3.1 模块（类）注释规范 模块开始必须以以下形式书写模块注释： ///summary ///定义某某类的方法 ////summary ///see cref=Author作者 /see ///see cref=Emailemail@ /see ///see cref=Data2003-12-17/see 如果模块有修改，则每次修改必须添加以下注释： ///remark备注版本修改信息，修改了那些，时间，每次依次增加remark/remark 3.3.2 类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary ///属性说明 /// /summary 3.3.3 方法注释规范 在类的方法声明前必须以以下格式编写注释 /// summary /// 说明：对该方法的说明 /// /summary /// param name=参数名称参数说明/param /// returns /对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 ///