文档介绍：Word专业资料
代码编写规说明书（c#.net与asp .net ）
目录
1目的
2围
3注释规
概述
自建代码文件注释
模块（类）注释
类属性注释
方法注释
代码间注释
4命名总体规则
5命名规
变量（Variable ）命名
常量命名
类（Class ）命名
接口（ In terface ）命名
方法（Method ）命名
名称空间Namespace ）命名
Word专业资料
6编码规则
错误检查规则
大括号规则
Word专业资料
8代码包规
Word专业资料
小括号规则
If Then Else 规则
比较规则
Case 规则
对齐规则
单语句规则
单一功能规则
简单功能规则
明确条件规则
选用FALSE规则
独立赋值规则
定义常量规则
模块化规则
交流规则
7编程准则
变量使用
数据库操作
对象使用
Word专业资料
8代码包规
Word专业资料
模块设计原则
结构化要求
函数返回值原则
代码包的版本号
代码包的标识9代码的控制
代码库/目录的建立
代码归档
10输入控制校验规则
登陆控制
数据录入控制
附件1 ：数据类型缩写表
附件2 :服务器控件名缩写表
1目的
为了统一公司软件开发设计过程的编程规
二. 使开发人员能很方便的理解每个目录，变
量，控件，类，方法的意义
Word专业资料
8代码包规
Word专业资料
三•为了保证编写出的程序都符合相同的规，保证一致性、统一性而建立的程序编码规。
四•编码规和约定必须能明显改善代码可读性，并有助于代码管理、分类围适用于企业所有
2围
本规适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3注释规
Word专业资料
a）注释要求英文及英文的标点符号。
b）注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c）每行注释的最大长度为 100个字符。
将注释与注释分隔符用一个空格分开。
不允许给注释加外框。
f）编码的同时书写注释。
重要变量必须有注释。
变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。
女口： int mJ Level,mJ Count; // mJLevel ....tree level
// mJ Co unt ....co unt of tree items
stri ng m_strSql; //SQL
8代码包规
Word专业资料
Word专业资料
i）典型算法必须有注释。
j）在循环和逻辑分支地方的上行必须就近书写注释。
k）程序段或语句的注释在程序段或语句的上一行
I）在代码交付之前，必须删掉临时的或无关的注释。
m） 为便于阅读代码，每行代码的长度应少
于100个字符。
自建代码文件注释
对于自己创建的代码文件（如函数、脚本） ，在文件开头，一般编写如下注释：
/★***★★**★★**★***★★*★★★**★★★★*★★★*★*★★★**★★***★****★**★
FileName:
Copyright （c） 2004-xxxx ********* 公司技术开发部
Writer:
8代码包规
Word专业资料
create Date:
Rewriter:
Rewrite Date:
Impact:
Main Content (Function Name、parameters、returns)
***★★**★★***★**★★***★***★★**★★★★★★*★***★★★★★★★★★★★★★★★/
模块(类)注释
模块开始必须以以下形式书写模块注释：
〃 /<summary>
///Module ID : v模块编号，可以引用系统设计中的模块编号 >
///Depiction : v对此类的描述，可以引用系统设计中的描述 >
/〃Author :作者中文名
///Create Date :〈模块创建日期，格式： YYYY-MM-DD> ///</summary>
如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：
///Rewriter Rewrite Date :〈修改日期：格式 YYYY・MM・DD> Startl
/*原代码容*/
〃/End1 :将原代码容注释掉，然后添加新代码使用以下注释：
///Added by Add date :〈添加日期，格式：YYYY