河南省 863 软件孵化器有限公司
编程规范(DOTNET)
DOTNET 编码规范
文件状态: [√] 草稿 [ [ ] 正式发布 ] 正在修改
文件标识: 当前版本: 作 者:
863SOFT_SPE_CODESTD(DOTNET) 1.0
完成日期:
2005-06-13
河南省 863 软件孵化器有限公司
1
河南省 863 软件孵化器有限公司
编程规范(DOTNET)
文档修订记录
版本编号或者 更改记录编号 *变化 状态 简要说明 日期 变更人 审核日期 审核人
*变化状态:A——增加,M——修改,D——删除
文档审批信息
职务 签字 日期
2
河南省 863 软件孵化器有限公司
编程规范(DOTNET)
目录
DOTNET 编码规范.......................................................................................................................... 1
文档修订记录........................................................................................................................... 2 1 命名规则介绍........................................................................................................................... 4 2 命名规范................................................................................................................................... 4 3 注释规范................................................................................................................................. 10 4 补充......................................................................................................................................... 11
3
河南省 863 软件孵化器有限公司
编程规范(DOTNET)
1 命名规则介绍
在代码编写中,
常用到 PASCAL 命名法、CAMEL 命名法、匈牙利命名法简单介绍如下:
1.1. PASCAL 命名法
Pascal 大小写形式-所有单词第一个字母大写,其他字母小写。 例如:UserName、PhoneNumber 等。
1.2. Camel 命名法
Camel 大小写形式-第一个单词小写,其他单词第一个字母大写,其余字母小写。 例如:userName、phoneNumber 等。
1.3. 匈牙利命名法
匈牙利命名法通过在变量名前面加上相应的小写字母的符号标识作为前缀, 标识出变量 的作用域,类型等。 例如:m_strUserName、m_strPhoneNumber 等。
2 命名规范
2.1. 项目命名规则
Pascal 格式,所有单词第一个字母大写,其他字母小写。总是和联编以及根命名空间相 同。
2.2. 资源文件命名规则
总是和类名相匹配,避免一个文件包含多个类的情况。
2.3. 名称空间命名规则
2.3.1. 采用有意义的命名空间名,例如产品名称或公司名称。 公司名称.技术名称[.Feature][.Design],如 System.Window.Form 2.3.2. 和类命名规范相同。
4
河南省 863
软件孵化器有限公司
编程规范(DOT
NET)
2.4. 类命名规则
2.4.1. 属性采用 Pascal 命名法,所有单词第一个字母大写,其他字母小写。 2.4.2. 名字应该能够标识事物的特性。 2.4.
3. 文件名要和主类类名匹配 例如:类 HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb) 2.4.3 名字尽量不使用缩写,除非它是众所周知的。 2.4.4 名字可以有两个或三个单词组成,但通常不应多于三个。 2.4.5 使用名词或名词短语命名类。 2.4.6 不要使用下划线字符 (_)。 2.4.7 使用 Attribute 作为自定义属性类的后缀。 2.4.8 使用 Exception 作为自定义属性类的后缀 例如: public class HelloWorld { … }
2.4. 接口命名规则
接口以 I 开头,其他和类命名规范相同。 例如: public interface IXXX
2.5. 方法命名规则
2.5.1. 和类命名规范相同。 2.5.2. 使用动词或动词短语,如 Remove();或 GetCharArray();等。 例如: void SayHello() { … }
2.6. 属性命名规则
2.6.1. 属性采用 Pascal 命名法,所有单词第一个字母大写