没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
.NET 命名规范
1. 前言
本文档是按照Maxlab日常C#代码书写规范化需要而对MSDN中《类库开发的设计准则》的
具体化,其中若有不详之处可以参考《准则》一文。MaxLab所有.NET项目都应严格遵守本代
码规范中的代码书写要求,代码书写规范将作为项目审核标准之一,所以请务必认真阅读本文档。
2. 大小写约定
大小写样式
本文中将出现两种大小写样式,这里先分别定义:
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标
识符使用 Pascal 大小写。例如:BackColor
Camel 大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor
标识符大小写规则
下表中列出常见的代码元素的样式规范和示例
标识符 样式 示例
类
Pascal AppDomain
枚举类型
Pascal ErrorLevel
枚举值
Pascal FatalError
事件
Pascal ValueChanged
异常类
Pascal WebException
只读的静态字段
Pascal RedValue
接口
Pascal IDisposable
方法
Pascal ToString
命名空间
Pascal System.Drawing
参数
Camel typeName
属性
Pascal
BackColor
常量 大写
REGEX_PARSE_URL
除了遵循以上大小写约定外还需注意以下约定(除常量为特例):
1.如果标识符由多个单词组成,请不要在各单词之间使用分隔符,如下划线(“_”)或连字符
(“-”)等。而应使用大小写来指示每个单词的开头。
2.所有公共的成员如:方法、属性,都应使用 Pascal 大小写样式
首缩写词的大小写规则
缩写词分为以下两种:
首字母缩写词
首字母缩写词是由术语或短语中各单词的首字母构成的单词。
例如,HTML 是 Hypertext Markup Language 的首字母缩写。
为了方便编码规范的实施,本文规定受字母缩写词必须至少为两个单词,正好为两个单词
的首字母缩写词称其为“短型首字母缩写词”
两个单词以上的称其为“长型首字母缩写词”
单缩写词
单缩写词是一个单词的缩写。例如,ID 是 identifier 的缩写。
注意:可在标识符中使用的两个缩写词是 ID 和 OK。在 采 用 Pascal 大小写格式的标识
符中,这两个缩写词的大小写形式应分别为 Id 和 Ok。
如果在采用大小写混合格式的标识符中将这两个缩写词用作首个单词,则它们的大小写形
式应分别为 id 和 ok。
首字母缩写词有以下大小写规则:
短型首字母缩写词在 Pascal 大小写样式中,两个字母都应大写。在 Camel 大小写样式
中,如果是首个单词,两个字母都应小写。
例如,名为 DBRate 的属性是一个采用 Pascal 大小写格式的标识符,它使用短型首字
母缩写词 (DB) 作为首个单词。
又如,名为 ioChannel 的参数是一个采用大小写混合格式的标识符,它使用短型首字
母缩写词 (IO) 作为首个单词。
长型首字母缩写词,在任何大小写样式中都视为一个单词。
例如,名为 XmlWriter 的类是一个采用 Pascal 大小写格式的标识符,它使用长型首
字母缩写词作为首个单词。
剩余14页未读,继续阅读
资源评论
yesboy
- 粉丝: 0
- 资源: 7
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功