C#代码编写规范.docx

代码编写规范（C#+数据库） TOC \o 1-5 \h \z 目的 4 范围 4 注释规范 4 概述 4.. 3.2自建代码文件注释 5. 模块（类）注释 6. 3.4类属性注释 8. 3.5方法注释 8. 3.6代码间注释 9. 命名总体规则 9 命名规范 10 变量（Variable）命名 .0 5.2常量命名 13 类（Class）命名 14 接口（ In terface）命名 15 方法（Method）命名 15 命名空间（NameSpace 命名 .5 编码规则 15 错误检查规则 15 大括号规则 1.6 6.3缩进规则 16 小括号规则 17 if else 规贝卩 18 比较规则 18 case 规则 19 6.8对齐规则 19 6.9单语句规则 19 6.10 单一功能规则 19 6.11简单功能规则 20 明确条件规则 20 选用false规则 20 独立赋值规则 20 定义常量规则 20 模块化规则 21 交流规则 2. 编程准则 21 7.1变量使用 2.1 7.2数据库操作 2. 7.3对象使用 22 7.4 模块设计原则 22 7.5结构化要求 22 7.6函数返回值原则 23 代码包规范 23 8.1代码包的版本号 24 8.2代码包的标识 24 代码的控制 26 9.1代码库/目录的建立 26 9.2代码归档 26 输入控制校验规则 26 10.1登陆控制 26 10.2数据录入控制 26 数据库命名规则 27 11. 1数据库表 27 11. 2表字段 27 11. 3 索引 28 11. 4 关联 28 11. 5储存过程 28 附：变量命名规范 28 附：VS.NET 2003控件命名规范 29 附：VS.NET 2005控件命名规范 31 目的 为了统一公司软件开发的设计过程中关于代码编写时的编写规 范和具体开发工作时的编程规范， 保证代码的一致性，便于交流和维 护，特制定此规范。 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写 阶段和后期维护阶段。 注释规范 3.1概述 注释中，应标明对象的完整的名称及其用途， 但应避免对代 码过于详细的描述。 每行注释的最大长度为100个字符。 将注释与注释分隔符用一个空格分开。 不允许给注释加外框。 编码的同时书写注释。 重要变量必须有注释。 变量注释和变量在同一行，所有注释必须对齐，与变量分开至 少两个“ Tab”键。 如:int iLevel, iCount; // iLevel tree level // iCo unt co unt of tree items stri ng strSql; //SQL 典型算法必须有注释。 在循环和逻辑分支地方的上行必须就近书写注释。 程序段或语句的注释在程序段或语句的上一行 在代码交付之前，必须删掉临时的或无关的注释。 为便于阅读代码，每行代码的长度应少于 100个字符。 3.2自建代码文件注释 对于自己创建的代码文件(如函数、脚本)，在文件开头，一 般编写如下注释： /************************************************ ****** FileName: 公司技术Copyright (c) 2004-xxxx ********* 公司技术 开发部 Writer: Create Date: Rewriter: Rewrite Date: Impact: Main Content ( Function Name、parameters、 retur ns) *********************************************** *******/ 3.3模块(类)注释 模块开始必须以以下形式书写模块注释： 〃/summary ///Module ID : 模块编号，可以引用系统设计中的模块编号 ///Depiction : 对此类的描述，可以引用系统设计中的描述 ///Author:作者中文名 ///Create Date： 模块创建日期，格式：YYYY-MM-DD ////summary 如果模块只进行部分少量代码的修改时，则每次修改须添加以 下注释： ///Rewriter: Rewrite Date： 修改日期，格式： YYYY-M M-DD Startl: /*原代码内容*/ 〃/Endi: 将原代码内容注释掉，然后添加新代码使用以下注释： ///Added by : Add date : 添加 日期，格式： YYYY-M M-DD Start2: 新代码内容 ///End2: 如果模块输入输出参数或功能结构有较大修改，则每次修改 必须添加以下注释： /