1 / 20
文档名称:

代码编写规范说明书.docx

格式:docx   大小:27KB   页数:20页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

代码编写规范说明书.docx

上传人:花开花落 2021/2/20 文件大小:27 KB

下载得到文件列表

代码编写规范说明书.docx

文档介绍

文档介绍: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

最近更新

2024年大学计算机基础等级考试题库及完整答案.. 21页

2024年大学计算机考试题库800道附答案(达标题.. 146页

2024年宪法知识竞赛题库附完整答案【典优】 49页

2024年普法学法知识竞赛题库往年题考 49页

2024年足球知识题库及参考答案【培优b卷】 12页

2024年马原测试题【能力提升】 79页

2024年马原试题含答案(突破训练) 78页

2024年马原题库400道附参考答案(能力提升) 79页

中国历史文化知识题库100道【基础题】 14页

中国历史文化知识题库100道精品(网校专用) 14页

全国计算机二级考试试题题库含完整答案【精选.. 96页

全国计算机等级考试(二级)考试题库及答案参.. 128页

公务员历史常识100题【达标题】 14页

历史类常识考试100题精品(达标题) 2页

县乡教师选调考试《教师职业道德》题库新版 42页

县乡教师选调进城考试《教育学》题库及参考答.. 116页

县乡教师选调进城考试《教育学》题库(各地真.. 117页

县乡教师选调进城考试《教育心理学》题库附完.. 120页

县乡教师选调进城考试《教育法律法规》题库精.. 131页

大学生计算机基础考试题库带精品答案 21页

大学计算机基础期末考试题库含答案【精练】 22页

大学计算机基础练习试题及答案【基础+提升】 22页

大学计算机基础考试试题200道及完整答案【各地.. 29页

大学计算机考试试题【必刷】 29页

大学计算机考试试题附答案(满分必刷) 28页

法律基础知识500题附答案(模拟题) 145页

陶瓷瓷器贴花工艺流程 4页

建筑水电安装线盒二次配管规范 3页

李霖Gary老师 忽然之间 吉他谱 4页

应用文写作总结 46页