c代码编写规范说明书.docVIP

目 录1 目的? 2 范围 3 注释规范 　　3.1 概述　　3.2 自建代码文件注释　　3.3 模块（类）注释　　3.4 类属性注释　　3.5 方法注释　　3.6 代码间注释4 命名总体规则5 命名规范　　5.1 变量（Variable）命名　　5.2 常量命名　　5.3 类（Class）命名　　5.4 接口（Interface）命名　　5.5 方法（Method）命名　　5.6 名称空间Namespace）命名6 编码规则　　6.1 错误检查规则　　6.2 大括号规则　　6.3 缩进规则　　6.4 小括号规则　　6.5 If Then Else规则　　6.6 比较规则　　6.7 Case规则　　6.8 对齐规则　　6.9 单语句规则　　6.10 单一功能规则　　6.11 简单功能规则　　6.12 明确条件规则　　6.13 选用FALSE规则　　6.14 独立赋值规则　　6.15 定义常量规则　　6.16 模块化规则　　6.17 交流规则7 编程准则　　7.1 变量使用　　7.2 数据库操作　　7.3 对象使用　　7.4 模块设计原则　　7.5 结构化要求　　7.6 函数返回值原则8 代码包规范　　8.1 代码包的版本号　　8.2 代码包的标识　　9 代码的控制　　9.1 代码库/目录的建立　　9.2 代码归档10 输入控制校验规则　　10.1 登陆控制　　10.2 数据录入控制附件1：数据类型缩写表附件2：服务器控件名缩写表 1 目的一.为了统一公司软件开发设计过程的编程规范二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作 2 范围本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3 注释规范3.1 概述a) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。b) 编码的同时书写注释。c) 重要变量必须有注释。d) 典型算法必须有注释。e) 在循环和逻辑分支地方的上行必须就近书写注释。f) 程序段或语句的注释在程序段或语句的上一行g) 在代码交付之前，必须删掉临时的或无关的注释。3.2 自建代码文件注释对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：/****************************************************** FileName:Copyright (c) 2004-xxxx *********公司技术开发部Author:create Date:******************************************************/3.3 模块（类）注释模块开始必须以以下形式书写模块注释： ///summary///Depiction：对此类的描述，可以引用系统设计中的描述///Author：作者中文名///Create Date：模块创建日期，格式：YYYY-MM-DD////summary 如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释： ///Rewriter Rewrite Date：修改日期:格式YYYY-MM-DD Start1： /* 原代码内容*////End1： 将原代码内容注释掉，然后添加新代码使用以下注释： ///Added by Add date：添加日期，格式：YYYY-MM-DD Start2： ///End2： ?如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释： ///summary///Log ID：Log编号,从1开始一次增加///depiction：对此修改的描述///Author：修改者中文名///Rewrite Date：模块修改日期，格式：YYYY-MM-DD////summary 3.4 类属性注释在类的属性必须以以下格式编写属性注释： /// summary/// Properties depiction/// /summary 3.5 方法注释在类的方法声明前必须以以下格式编写注释 /// summary/// depiction：对该方法的说明/// /summary/// param name=参数名称参数说明/param/// returns///对方法返回值的说明，该