文档介绍:c#.net 与
代码编写规范说明书( ) 目录
1目的
2范围
3注释规范
(类)注释
4命名总体规则
5命名规范
变虽(Variable )命名
类(Class )命名
接口( Interface )命名
方法(Method )命名
^命名
6编码规则
If Then Else 规则
Case 规则
7编程准则
8代码包规范
9代码的控制
10输入控制校验规则
附件1 :数据类型缩写表
附件2 :服务器控件名缩写表
1目的
为了统一公司软件开发设计过程的编程规范
使网站开发人员能很方便的理解每个目录 ,变虽,控件,类,方法的意义
为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范
编码规范和约定必须能明显改善代码可读性,并有助于代码管理、分类范围适用
2范围
本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。
3注释规范
a) 注释要求英文及英文的标点符号。
b) 注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。
c) 每行注释的最大长度为 100 个字符。
d) 将注释与注释分隔符用一个空格分开。
e) 不允许给注释加外框。
f) 编码的同时书写注释。
g) 重要变虽必须有注释。
h) 变虽注释和变虽在同一行,所有注释必须对齐,与变虽分开至少四个“空格”
键。如: int m_iLevel,m_iCount; // m_iLevel ....tree level
// m_iCount ....count of tree items
string m_strSql; //SQL
i) 典型算法必须有注释。
j) 在循环和逻辑分支地方的上行必须就近书写注释。
k) 程序段或语句的注释在程序段或语句的上一行
l) 在代码交付之前,必须删掉临时的或无关的注释。
m) 为便于阅读代码,每行代码的长度应少于 100个字符。
对于自己创建的代码文件(如函数、脚 ,在文件开头,一般编写如下注释:
/******************************************************
FileName:
Copyright (c) 2004-xxxx ********* 公司技术开发部
Writer:
create Date:
Rewriter:
Rewrite Date:
(Function Name 、 parameters 、returns )
Impact:
Main
Content
******************************************************/ (类)注释
模块开始必须以以下形式书写模块注释:
///<summary>
///Module : <模块编号,可以引用系统设计中的模块 >
编号
ID >
: <对此类的描述,可以引用系统设计中的
///Depicti 描述
on
///Author :作者中文名
///Create Date : <模块仓建日期, YYYY-MM-DD>
格式:
///</summary>
如果模块只进行部分少虽代码的修改时,则每次修改须添加以下注释:
///Rewriter Rewrite Date : <修改日期:格式 YYYY-MM-DD> Start1
/*原代码内容*/
///End1
将原代码内容注释掉,然后添加新代码使用以下注释:
///Added by Add date : < 添加日期,格式: YYYY-MM-D