代码书写规范v1.0.0(c#).docVIP

代码书写规范 撰写时间： 撰写人（签字）： 审批人（签字）： 审批日期： 变更记录 版本号 修改点说明 变更人 存放位置 审批人 审批日期 目 录 TOC \o 1-3 \h \z \u 前言 5 一.?命名规则 5 a)?命名空间命名规则 5 1.?拼写规范 5 2.?命名空间划分 5 b)?类命名规则 6 1.?拼写规范 6 二.?书写规范 6 c)?类成员变量命名规则 6 d) 控件命名规则 6 e)?枚举和结构命名规则 7 f)?方法命名规则 7 g)?属性命名规则 8 i)?局部变量命名 8 j) 接口的命名 9 三.?注释书写规范 9 k)?命名空间注释 9 l)?类注释 9 m)?类成员变量注释 10 n)?方法注释 10 o)?内部注释 10 四.?代码页面布局规范 11 p)?代码格式 11 1)?缩进 11 2)?折行 11 3)?分区 11 五.?代码书写规范 11 六. 数据库操作 12 七. 其它规定 12 附录A：名称空间申报表 14 附录B：常用控件命名规则 15 附录C：代码规范样例 17 前言 为了方便本项目组成员之间的沟通与交流，增强系统设计过程的规范性，在此规定代码书写规范。自此规范发布之日起后开展的项目，规范中强制性条款需要严格遵守。规范在执行过程中如产生有争议的条款，通过会议讨论进行统一。 一.?命名规则 a)?命名空间命名规则 1.?拼写规范 命名空间的名称拼写采用Pascal形式，首字母大写，其它字母小写。大写单词首字母作为分隔，例如：RailwayStation。名称应当为能够表示中文意义的英文单词组成。如果采用缩写，缩写字母必须使用大写方式。除人名、地名外，不允许使用中文拼音。命名空间的名字不能过长，原则上不超过20个字母。 2.?命名空间划分 每一个项目只存在一个主命名空间，例如ESINT.XXX。项目下的各个子项目的名称空间由各项目组自行定义，但必须在命名空间申报处申报，例如ESINT. XXX.Model命名空间。如果项目组采用三层结构模式模型开发项目，则各层结构的名称空间必须以如下方式命名： ESINT.XXX.DAL(数据访问层)，ESINT.XXX.BLL(业务逻辑层)，ESINT.XXX.Model(实体层)，ESINT. XXX.Web(B/S表示层)，ESINT.XXX.Utility(公用函数层) ，ESINT. XXX.Form (C/S表示层), “XXX”为各项目的名称. 严禁在项目中使用未申报的命名空间。名称空间申报表结构见附录A b)?类命名规则 1.?拼写规范 类名拼写采用Pascal形式，首字母大写，其它字母小写。大写单词首字母作为分隔，例如：RailwayStation。名称应当为能够表示中文意义的英文单词组成，尽量不使用缩写。类名称应当为名词或者为形容词+名词。除人名、地名外，尽量不使用中文拼音。类名不能过长，原则上不超过20个字母。 二.?书写规范 一个文件中(.cs文件)中只能包含一个类。 c)?类成员变量命名规则 对于类私有成员变量名采用Camel拼写方式。首字母为小写，名字前加“_”。如： private string _firstName; 类不能使用非私有的成员变量。应当通过属性的方式对外公开内部成员。 d) 控件命名规则 控件成员作为一个特例采用匈牙利命名法，前三位为缩写，常用缩写详见: 附录B e)?枚举和结构命名规则 枚举和结构采用Pascal拼写方式。对于枚举类型，不仅枚举类型名采用Pascal拼写，枚举选项同样采用Pascal拼写。例如： public enum CustormerType { ?? Consumer, ?? Commercial } f)?方法命名规则 方法采用Pascal拼写方式。名称以英文单词组成。采用动词或动词+名词的形式,动宾短语形式。如：public void Excute(),public string GetInvoiceNo()。对于方法中的参数名，采用“类型缩写+Pascal”拼写方式，如：public string GetInvoiceNo(string strProductName)。参数如果为自定义类型则采用“obj+类名称”拼写方式，如：public string GetInvoiceNo(User objUser)。对于一些表示判断的方法应当使用这样的形式： IsNumeric,HasDeleted,CanOpen。采用Is、Can、Has前缀的方法必须以bool型作为返回值。 表示“是否为”，采用Is前缀。如：IsNumeric。 表示“能否”,采用Can前缀。