没有合适的资源?快使用搜索试试~ 我知道了~
首页代码编写规范说明书(c#与asp.net)
资源详情
资源评论
资源推荐

目 录
目的
范围
注释规范
概述
自建代码文件注释
模块(类)注释
类属性注释
方法注释
代码间注释
命名总体规则
命名规范
变量()命名
常量命名
类()命名
接口()命名
方法()命名
名称空间 )命名
编码规则
错误检查规则
大括号规则
缩进规则
小括号规则
规则
比较规则
规则
!对齐规则
"单语句规则
#单一功能规则
简单功能规则
明确条件规则
选用 $%&' 规则
独立赋值规则
定义常量规则
模块化规则
交流规则
编程准则
变量使用
数据库操作
对象使用
模块设计原则
结构化要求
函数返回值原则
!代码包规范

!代码包的版本号
!代码包的标识
"代码的控制
"代码库(目录的建立
"代码归档
#输入控制校验规则
#登陆控制
#数据录入控制
附件 :数据类型缩写表
附件 :服务器控件名缩写表
1 目的
一为了统一公司软件开发设计过程的编程规范
二使网站开发人员能很方便的理解每个目录)变量,控件,类,方法的意义
三为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。
四编码规范和约定必须能明显改善代码可读性,并有助于代码管理、分类范围适用于企业所有基
于 平台的软件开发工作
2 范围
本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。
3 注释规范
概述
*注释要求英文及英文的标点符号。
*注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。
*每行注释的最大长度为 ## 个字符。
*将注释与注释分隔符用一个空格分开。
*不允许给注释加外框。
*编码的同时书写注释。
+*重要变量必须有注释。
*变量注释和变量在同一行,所有注释必须对齐,与变量分开至少四个“空格”键。
如:,&-),./((,&--
((,..
+,'0/(('1&
*典型算法必须有注释。
2*在循环和逻辑分支地方的上行必须就近书写注释。
3*程序段或语句的注释在程序段或语句的上一行
*在代码交付之前,必须删掉临时的或无关的注释。
*为便于阅读代码,每行代码的长度应少于 ## 个字符。
自建代码文件注释
对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释:
(444444444444444444444444444444444444444444444444444444

$5
6+7*##89999444444444公司技术开发部
:5
;5
<=5
<=;5
5
($.、、.)
444444444444444444444444444444444444444444444444444444(
模块(类)注释
模块开始必须以以下形式书写模块注释:
(((>.6?
(((.;:>模块编号,可以引用系统设计中的模块编号?
(((;:>对此类的描述,可以引用系统设计中的描述?
(((%.:作者中文名
(((;:>模块创建日期,格式:@@@@88;;?
(((>(.6?
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:
(((<=<=;:>修改日期5格式 @@@@88;;?':
(4原代码内容4(
(((:
将原代码内容注释掉,然后添加新代码使用以下注释:
(((%6%:>添加日期,格式:@@@@88;;?':
(((:
A
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下注释:
(((>.6?
(((&+;:>&+ 编号)从 开始一次增加?
(((:>对此修改的描述?
(((::修改者中文名
(((<=;:>模块修改日期,格式:@@@@88;;?
(((>(.6?
剩余14页未读,继续阅读

















安全验证
文档复制为VIP权益,开通VIP直接复制

评论2