没有合适的资源?快使用搜索试试~ 我知道了~
C#代码编写规范.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 57 浏览量
2021-10-02
11:19:11
上传
评论
收藏 36KB PDF 举报
温馨提示
试读
20页
C#代码编写规范.pdf
资源推荐
资源详情
资源评论
C#代码编写规范
目录
目录 1 目的 .............................................................................................................................................. 2
1 目的 ....................................................................................................................................................... 4
2 适应范围 ............................................................................................................................................... 4
3 术语及缩略语 ....................................................................................................................................... 4
4 规范内容 ............................................................................................................................................... 4
4.1 命名总体规则 ................................................................................................................................ 4
4.2 命名规范 ........................................................................................................................................ 5
4.2.1
变量命名
................................................................................................................................. 5
4.2.2 常量命名 ................................................................................................................................. 7
4.2.3
类
(Class)
命名
......................................................................................................................... 7
4.2.4
接口
(Interface)
命名
................................................................................................................ 7
4.2.5 方法(Method) 命名 .................................................................................................................. 8
4.2.6
命名空间
(NameSpace)
命名
................................................................................................... 8
4.2.7 属性(Property) 命名 ................................................................................................................ 8
4.3 注释规范 ........................................................................................................................................ 8
4.3.1
概述
......................................................................................................................................... 8
4.3.2 自建代码文件注释 ................................................................................................................. 9
4.3.3
模块
(
类
)
注释
.......................................................................................................................... 9
4.3.4 类属性注释 ........................................................................................................................... 10
4.3.5
方法注释
............................................................................................................................... 10
4.3.6
代码间注释
........................................................................................................................... 11
4.4 编码规则 ...................................................................................................................................... 11
4.4.1
错误检查规则
....................................................................................................................... 11
4.4.2 大括号规则 ........................................................................................................................... 11
4.4.3
小括号规则
........................................................................................................................... 11
4.4.4
缩进规则
............................................................................................................................... 12
4.4.5
对齐规则
............................................................................................................................... 12
4.4.6
比较规则
............................................................................................................................... 12
4.4.7 Case 规则.............................................................................................................................. 12
4.4.8 If … Else
规则
....................................................................................................................... 12
4.4.9
单语句规则
........................................................................................................................... 13
4.4.10
单一功能准则
..................................................................................................................... 13
4.4.11
简单功能准则
..................................................................................................................... 13
4.4.12 明确条件规则 ..................................................................................................................... 13
4.4.13
选用
False
规则
.................................................................................................................. 13
4.4.14
独立赋值规则
..................................................................................................................... 13
4.4.15
定义常量规则
..................................................................................................................... 14
4.4.16
模块化规则
......................................................................................................................... 14
4.4.17
交流规则
............................................................................................................................. 14
4.5 编程准则 ...................................................................................................................................... 14
4.5.1
变量使用
............................................................................................................................... 14
4.5.2 数据库操作 ........................................................................................................................... 14
4.5.3
对象使用
............................................................................................................................... 15
4.5.4
模块设计原则
....................................................................................................................... 15
4.5.5 结构化要求 ........................................................................................................................... 15
4.5.6
函数返回值原则
................................................................................................................... 16
4.6 代码包规范 .................................................................................................................................. 16
4.6.1
代码包的版本号
................................................................................................................... 16
4.6.2
代码包的标识
....................................................................................................................... 16
4.7 代码控制 ...................................................................................................................................... 17
4.7.1
代码库
/
目录的建立
.............................................................................................................. 17
4.7.2 代码归档 ............................................................................................................................... 17
附件 1:数据类型缩写表 ................................................................................................................. 17
附件 2:控件名缩写表 ..................................................................................................................... 18
a、.NET 控件 ................................................................................................................................ 18
b
、
html
控件
.................................................................................................................................. 19
c、ADO.NET 控件 ........................................................................................................................ 20
1 目的
a) 为了统一公司软件开发设计过程的编程规范;
b) 使开发人员能方便的理解每个目录、变量、控件、类、方法的意义;
c) 为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程
序编码规范;
d) 编码规范和约定必须能明显改善代码可读性,并有助于代码管理;
2 适应范围
本规范适用于企业所有基于 .NET 平台的软件开发人员,作用于软件项目开
发的代码编写阶段和后期维护阶段。
3 术语及缩略语
4 规范内容
4.1 命名总体规则
a) 名字应该能够标识事物的特性。
b) 名字一律使用英文单词,而不能为拼音。
c) 名字尽量不使用缩写,除非它是众所周知的。
d) 名字可以有两个或三个单词组成,但不应多于三个,控制在 3 至 30 个
字母以内。
e) 在名字中, 多个单词用大写第一个字母 (其它字母小写) 来分隔。 例如:
IsSuperUser 。
f) 名字尽量使用前缀而不是后缀。
g) 名字中的单词尽量使用名词,如有动词,也尽量放在后面。例如:
FunctionUserDelete (而不是 FunctionDeleteUser )。
剩余19页未读,继续阅读
资源评论
资料大全
- 粉丝: 14
- 资源: 26万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功