没有合适的资源?快使用搜索试试~ 我知道了~
首页代码编写规范说明书(c#.net与asp.net)
代码编写规范说明书(c#.net与asp.net)
5星 · 超过95%的资源 需积分: 10 17 下载量 17 浏览量
更新于2023-03-03
评论
收藏 52KB DOC 举报
代码编写规范说明书(c#.net与asp.net) 1 目的 一.为了统一公司软件开发设计过程的编程规范 二.使网站开发人员能很方便的理解每个目录,变量,控件,类,方法的意义 三.为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。 四.编码规范和约定必须能明显改善代码可读性,并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作
资源详情
资源评论
资源推荐
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:<对此类的描述,可以引用系统设计中的描述>
///Author:作者中文名
///Create Date:<模块创建日期,格式:YYYY-MM-DD>
///</summary>
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:
///Rewriter Rewrite Date:<修改日期:格式 YYYY-MM-DD> Start1:ÚÚÚÚÚÚÚÚÚ
/* 原代码内容*/
///End1:ÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚ
将原代码内容注释掉,然后添加新代码使用以下注释:
///Added by Add date:<添加日期,格式:YYYY-MM-DD> Start2:ÚÚÚÚÚÚÚÚ
///End2:ÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚÚ
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下注释:
///<summary>
///Log ID:<Log 编号,从 1 开始一次增加>
///depiction:<对此修改的描述>
///Writer:修改者中文名
///Rewrite Date:<模块修改日期,格式:YYYY-MM-DD>
///</summary>
3.4 类属性注释
在类的属性必须以以下格式编写属性注释:
/// <summary>
/// <Properties depiction>
/// </summary>
3.5 方法注释
在类的方法声明前必须以以下格式编写注释
/// <summary>
/// depiction:<对该方法的说明>
/// </summary>
/// <param name="<参数名称>"><参数说明></param>
/// <returns>
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
/// </returns>
///Writer:作者中文名
///Create Date:<方法创建日期,格式:YYYY-MM-DD>
3.6 代码间注释
代码间注释分为单行注释和多行注释:
//<单行注释>
/*多行注释 1
多行注释 2
多行注释 3*/
代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实
现手段(所用算法等等)。
4 命名总体规则
名字应该能够标识事物的特性。
名字一律使用英文单词,而不能为拼音。
名字尽量不使用缩写,除非它是众所周知的。
名字可以有两个或三个单词组成,但不应多于三个,控制在 3 至 30 个字母以内。
在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
名字尽量使用前缀而不是后缀。
名字中的单词尽量使用名词,如有动词,也尽量放在后面。例如: FunctionUserDelete(而不是
FunctionDeleteUser)。
5 命名规范
5.1 变量(Variable)命名
a) 程序文件(*.cs)中的变量命名
程序中变量名称Ú= 变量的前缀Ú+代表变量含意的英文单词或单词缩写。
类模块级的变量请用“m_” +数据类型缩写作为前缀(其中,m 为“memory”缩写,数据类型缩写
见附件中的《数据类型缩写表》)。ÚÚ
public class hello
{
private string m_strName;
private DateTime m_dtDate;
}
类的属性所对应的变量,采用属性名前加“m_”+ 类型缩写Ú前缀的形式
public class hello
{
private string m_strName;
public string Name
{
get
{
return m_strName;
}
}
}
过程级的变量使用类型缩写前缀
public class hello
{
void say()
{
string strSayWord;
}
}
过程的参数使用“p_”+ 类型缩写作为前缀(其中,p 为“parameter”缩写)
public class hello
{
void say(string p_strSayWord)
{
}
}
剩余10页未读,继续阅读
liping490840367
- 粉丝: 1
- 资源: 17
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- ExcelVBA中的Range和Cells用法说明.pdf
- 基于单片机的电梯控制模型设计.doc
- 主成分分析和因子分析.pptx
- 共享笔记服务系统论文.doc
- 基于数据治理体系的数据中台实践分享.pptx
- 变压器的铭牌和额定值.pptx
- 计算机网络课程设计报告--用winsock设计Ping应用程序.doc
- 高电压技术课件:第03章 液体和固体介质的电气特性.pdf
- Oracle商务智能精华介绍.pptx
- 基于单片机的输液滴速控制系统设计文档.doc
- dw考试题 5套.pdf
- 学生档案管理系统详细设计说明书.doc
- 操作系统PPT课件.pptx
- 智慧路边停车管理系统方案.pptx
- 【企业内控系列】企业内部控制之人力资源管理控制(17页).doc
- 温度传感器分类与特点.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论2