C#编码规范.doc免费

文档状态： 文档编号： 规范_C#编码 [ ] Draft [√] Released [ ] Modifing 编 撰： 王英杰 编撰日期： 2006-5-21 保密级别： 机密 文档版本： 2.0.0 C#编码规范 铁道科学研究院电子计算技术研究所 北京经纬信息技术公司 版 本 历 史 日期 版本 说明 作者 2006-04-08 0.0.1 初稿 王英杰 2006-04-24 1.0.0 修订 佘振国 2006-04-30 1.0.0 咨询公司审计通过，正式发布 EPG 2006-05-21 2.0.0 增加系统集成项目过程 佘振国 目 录 1 目的 4 2 范围 4 3 规范内容 4 代码格式 4 注释（Comment）规范 5 变量（Variable）命名规范 7 常量命名规范 9 类（Class）命名规范 9 类的实例命名规范 10 接口（Interface）命名规范 10 方法（Method）、属性（Atribute）命名规范 10 命名空间（NameSpace）命名规范 11 窗口(Form)命名规范 11 4 编码实践经验 11  C#编码规范 目的 为了保证所每个项目组编写出的程序都符合相同的规范保证一致性、统一性而 代码格式 所有的缩进为4个空格，使用VS.NET的默认设置。 在代码中垂直对齐左括号和右括号。 if (x == 0) { Response.Write(用户编号必须输入！); } 不允许以下情况： if (x == 0) { Response.Write(用户编号必须输入！); } 或者： if (x == 0){ Response.Write(用户编号必须输入！);} 为了防止在阅读代码时滚动源代码编辑器，每行代码或注释在1024*768的分辨率下尽量不超过一显示屏。 当一行被分为几行时，将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。缩进方式采用默认格式。 每一行上放置的语句避免超过一条。 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。例： int j = i + k; 而不应写为 int j=i+k; 将大的复杂代码节分为较小的、易于理解的模块。 编写 SQL 语句时，建议（不强求）对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例如： SELECT FirstName, LastName FROM Customers WHERE State = WA 使用括号的目的必须是在表达上不但能够标明优先顺序，而且有助于使表达更简单明了。另外，如果某一段代码有可能产生歧义，也需加括号。 注释（Comment）规范 注释规范包括：模块（类）注释规范、类属性注释规范、方法注释规范、代码间注释规范。 模块（类）注释规范 模块开始尽量以以下形式书写模块注释： ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ///版本号(version) ///公司(copyright) /// 创建标识： ////summary 当模块有重大修改或修改他人代码时，必须添加以下注释： ///summary ///Log编号：Log编号，从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD ////summary 修改时根据需要保留程序员第一次和最近一次修改的代码。具体办法是将原有代码注释。 (保留第一次的代码可以反映此部分代码最初要实现的功能及其初始编程思想，保留最新的代码可以反映此代码最近变化要实现的最新功能) 类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary ///属性说明 /// /summary 方法注释规范 在类的方法声明前必须以以下格式编写注释： /// summary /// 说明：对该方法的说明 /// /summary /// param name=参数名称参数说明/param /// returns对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 /returns ///exception异常类型、异常结果说明（为什么产生此异常）/exception 在Visual Studio环境中，