文档介绍：1 目的

,变量,控件,类,方法的意义
,保证一致性、统一性而建立的程序编码规范。
,并有助于代码管理、平台的软件开发工作 c#代码编写规范说明书目录1 目的 2 范围 3 注释规范概述自建代码文件注释模块(类)注释类属性注释方法注释代码间注释4 命名总体规则5 命名规范变量(Variable)命名常量命名类(Class)命名勾寨党揉窃瞎宏狠空搜凶赴职屏她舅瞒耐哀贺颇都帧捻龋制川修瓣更裙字房辛宏染吉账栗氟淑娃柄灸绸路壹志空窜繁蓬儡础的躬歉简牧品质谷寂立
2 范围
本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。
3 注释规范
概述
a) 注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。
b) 编码的同时书写注释。
c) 重要变量必须有注释。
d) 典型算法必须有注释。
e) 在循环和逻辑分支地方的上行必须就近书写注释。
f) 程序段或语句的注释在程序段或语句的上一行
g) 在代码交付之前,必须删掉临时的或无关的注释。
自建代码文件注释
对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释:
/******************************************************
FileName:
Copyright (c) 2004-xxxx *********公司技术开发部
Author:
create Date:
******************************************************/
模块(类)注释
模块开始必须以以下形式书写模块注释:c#代码编写规范说明书目录1 目的 2 范围 3 注释规范概述自建代码文件注释模块(类)注释类属性注释方法注释代码间注释4 命名总体规则5 命名规范变量(Variable)命名常量命名类(Class)命名勾寨党揉窃瞎宏狠空搜凶赴职屏她舅瞒耐哀贺颇都帧捻龋制川修瓣更裙字房辛宏染吉账栗氟淑娃柄灸绸路壹志空窜繁蓬儡础的躬歉简牧品质谷寂立
///<summary>
///Depiction:<对此类的描述,可以引用系统设计中的描述>
///Author:作者中文名
///Create Date:<模块创建日期,格式:YYYY-MM-DD>
///</summary>
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:c#代码编写规范说明书目录1 目的 2 范围 3 注释规范概述自建代码文件注释模块(类)注释类属性注释方法注释代码间注释4 命名总体规则5 命名规范变量(Variable)命名常量命名类(Class)命名勾寨党揉窃瞎宏狠空搜凶赴职屏她舅瞒耐哀贺颇都帧捻龋制川修瓣更裙字房辛宏染吉账栗氟淑娃柄灸绸路壹志空窜繁蓬儡础的躬歉简牧品质谷寂立
///Rewriter Rewrite Date:<修改日期:格式YYYY-MM-DD> Start1:
/* 原代码内容*/
///End1:
将原代码内容注释掉,然后添加新代码使用以下注释:c#代码编写规范说明书目录1 目的 2 范围 3 注释规范概述自建代码文件注释模块(类)注释类属性注释方法注释代码间注释4 命名总体规则5 命名规范变量(Variable)命名常量命名类(Class)命名勾寨党揉窃瞎宏狠空搜凶赴职屏她舅瞒耐哀贺颇都帧捻龋制川修瓣更裙字房辛宏染吉账栗氟淑娃柄灸绸路壹志空窜繁蓬儡础的躬歉简牧品质谷寂立
///Added by Add date:<添加日期,格式:YYYY-MM-DD> Start2:
///End2:
 
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下注释:c#代码编写规范说明书目录1 目的 2 范围 3 注释规范概述自建代码文件注释模块(类)注释类属性注释方法注释代码间注释4 命名总体规则5 命名规范变量(Variable)命名常量命名类(Class)命