代码编写规范说明书.doc

Revised by Petrel at 2021
代码编写规范说明书
代码编写规范说明书（c#.）
目录
1目的
2范围
3注释规范


（类）注释



4命名总体规则
5命名规范
（Variable）命名

（Class）命名
（Interface）命名
（Method）命名
）命名
6编码规则

















7编程准则






8代码包规范


9代码的控制


10输入控制校验规则


附件1：数据类型缩写表
附件2：服务器控件名缩写表
1目的

,变量，控件，类，方法的意义
，保证一致性、统一性而建立的程序编码规范。
，并有助于代码管理、
2范围
本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3注释规范

a)注释要求英文及英文的标点符号。
b)注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c)每行注释的最大长度为100个字符。
d)将注释与注释分隔符用一个空格分开。
e)不允许给注释加外框。
f)编码的同时书写注释。
g)重要变量必须有注释。
h)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。
如：intm_iLevel,m_iCount;//m_iLevel....treelevel
//m_iCount....countoftreeitems
stringm_strSql;//SQL
i)典型算法必须有注释。
j)在循环和逻辑分支地方的上行必须就近书写注释。
k)程序段或语句的注释在程序段或语句的上一行
l)在代码交付之前，必须删掉临时的或无关的注释。
m)为便于阅读代码，每行代码的长度应少于100个字符。

对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：
/******************************************************
FileName:
Copyright(c)2004-xxxx*********公司技术开发部
Writer:
createDate:
Rewriter:
RewriteDate:
Impact:
MainContent（FunctionName、parameters、returns）
******************************************************/
（类）注释
模块开始必须以以下形式书写模块注释：
///<summary>
///ModuleID：<模块编号，可以引用系统设计中的模块编号>
///Depiction：<对此类的描述，可以引用系统设计中的描述>
///Author：作者中文名
///CreateDate：<模块创建日期，格式：YYYY-MM-DD>
///</summary>
如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：
///RewriterRewriteDate：<修改日期:格式YYYY-MM-DD>Start1：
/*原代码内容*/
///End1：
将原代码内容注释掉，然后添加新代码使用以下注释：
///AddedbyAdddate：<添加日期，格式：YYYY-MM-DD>Start2：
///End2：
如果模块输入