C#编码规范(修改版)v12.docVIP

C# 编码规范 [　] 草稿文件 当前版本： 1.0 [√] 正式文件 发布组织： Kevin [　] 正在修改 完成日期： 2006年8月4日 目录C#编码规范 1 1 目的 2 2 范围 2 3 注释规范 2 3.1 概述 2 3.2 自建代码文件注释 2 3.3 模块（类）注释 3 3.4 方法注释 4 3.5 代码间注释 4 4 命名规范 4 4.1 命名总体规则 4 4.2 变量（Variable）命名 4 4.3 常量命名 6 4.4 类（Class）命名 6 4.5 接口（Interface）命名 7 4.6 方法（Method）命名 7 4.7 命名空间（NameSpace）命名 7 5 编码规则 7 5.1 错误检查规则 7 5.2 大括号规则 7 5.3 缩进规则 7 5.4 If Then Else规则 8 5.5 Case规则 8 5.6 对齐规则 9 5.7 单语句规则 9 5.8 单一功能规则 9 5.9 选用FALSE与0的规则 9 5.10 独立赋值规则 10 5.11 定义常量规则 10 5.12 模块化规则 10 5.13 避免不良编写风格 10 5.14 循环的效率 11 5.15 空行的使用 11 6 编程准则 12 6.1 变量使用 12 6.2 数据库操作 12 6.3 对象使用 13 6.4 模块设计原则 13 7 代码包规范 13 7.1 代码包的版本号 13 8 数据库命名规范: 13 9 附件1：数据类型缩写表 14 10 附件2：服务器控件名缩写表 14 目的 为统一公司软件开发设计过程的编程规范 （1）使开发人员能很方便的理解每个目录,变量，控件，类，方法的意义 （3）保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 注释规范 概述 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。将注释与注释分隔符用一个空格分开。不允许给注释加外框。重要变量必须有注释。变量注释和变量在同一行，所有注释必须对齐，与变量分开至少一个TAB键。如： string m_strSql// SQL （6）典型算法必须有注释。每行的长度应少于100个字符。自建代码文件注释 自己创建的代码文件（如函数、脚本），版权和版本的声明位于，头文件和定义文件的开头，一般编写如下注释：/***************************************************** * Copyright（C）2006, 天津七所信息技术有限公司软件部 * All rights reserved. * * 文件名称：XXXXX // 项目名-画面名 * 文件标识：见计划书 // Project No.XXX- No.XXX * 摘　　要：简要描述本文件的内容 * * 取代版本：1. 0 * 原 作 者：输入原作者（或修改者）名字 * 完成日期：2006年7月18日 * * 当前版本：1. 1 * 作　　者：输入最终修改者名字 * 完成日期：2006年8月20日 *****************************************************/ 模块（类）注释 模块开始必须以以下形式书写模块注释：/// summary /// Module ID： 模块编号，可以引用系统设计中的模块编号 /// Depiction： 对此类的描述，可以引用系统设计中的描述 /// Author：作者名/// Create Date： 模块创建日期，格式：YYYY-MM-DD /// /summary （2）如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：/// Rewriter Rewrite Date：修改日期:格式YYYY-MM-DD：/* 原代码内容/ ///End1：将原代码内容注释掉，然后添加新代码使用以下注释：///Added by Add date：添加日期，格式：YYYY-MM-DD：///End2：类的属性以下格式编写属性注释：/// summary /// Properties depiction /// /summary 方法注释 在类的方法声明前以下格式编写注释 /// summary /// depiction：对该方法的说明/// /summary /// param name=参数名称参数说明/param /// returns /// 对方法返