代码编写规范说明书（c#.net与asp.net）
5星 · 超过95%的资源 需积分: 10 56 浏览量
2010-01-30
22:53:15
上传
评论
收藏 52KB DOC 举报 
1 目的
一.为了统一公司软件开发设计过程的编程规范
二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义
三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。
四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于 .NET
平台的软件开发工作
2 范围
本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3 注释规范
3.1 概述
a) 注释要求英文及英文的标点符号。
b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c) 每行注释的最大长度为 100 个字符。
d) 将注释与注释分隔符用一个空格分开。
e) 不允许给注释加外框。
f) 编码的同时书写注释。
g) 重要变量必须有注释。
h) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。
如：intm_iLevel,m_iCount; // m_iLevel ....tree level
// m_iCount ....count of tree items
string m_strSql; //SQL
i) 典型算法必须有注释。
j) 在循环和逻辑分支地方的上行必须就近书写注释。
k) 程序段或语句的注释在程序段或语句的上一行
l) 在代码交付之前，必须删掉临时的或无关的注释。
m) 为便于阅读代码，每行代码的长度应少于 100 个字符。
3.2 自建代码文件注释
对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：
/******************************************************
FileName:
Copyright(c)2004-xxxx *********公司技术开发部
Writer:
create Date:
Rewriter:
Rewrite Date:
Impact:
Main Content（Function Name、parameters、returns）
******************************************************/
3.3 模块（类）注释
模块开始必须以以下形式书写模块注释：
///<summary>
///Module ID：<模块编号，可以引用系统设计中的模块编号>
///Depiction：<对此类的描述，可以引用系统设计中的描述>
剩余10页未读，继续阅读
评论2
最新资源