.Net项目代码编写规范

《.Net项目代码编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、目录1.C#代码风格要求31.1注释31.2类型（类、结构、委托、接口）、字段、属性、方法、事件的命名31.3不使用缩写41.4代码使用半展开41.5使用Tab作为缩进，并设置缩进大小为451.6一个.cs源文件至多定义两个类型71.7类型名称和源文件名称必须一致71.8所有命名空间、类型名称使用Pascal风格（单词首字母大写）71.9本地变量、方法参数名称使用Camel风格（首字母小写，其后每个单词的首字母大写）71.10私有方法、受保护方法，仍使用Pascal风格命名81.11如果if语句内容只有一行，可

2、以不加花括号，但是必须和if语句位于同一行81.12调用类型内部其他成员，需加this；调用父类成员，需加base91.13类型内部的私有和受保护字段，使用Camel风格命名，但加“_”前缀91.14不能出现公有字段101.15类型成员的排列顺序101.16委托和事件的命名111.17返回bool类型的方法、属性的命名111.18常见集合类型后缀命名121.19常见后缀命名121.20常见类型命名131.21常见字段、属性命名142.XHTML代码风格要求142.1如果XHTML标记有层次，那么代码也要有层次1

3、42.2所有标记必须闭合152.3如果标记中间代码超过20行，则应在标记末尾加注标识153.CSS代码风格要求163.1代码使用半展开163.2使用Tab作为缩进，并设置缩进大小为4163.3代码注释163.4代码编写163.5嵌入式样式的比例不超过样式表代码总量的10%173.6内联式样式的比例不超过样式表代码总量的30%173.7外联式样式表的比例不少于样式表代码总量的60%174.JavaScript代码风格要求184.1代码使用半展开184.2使用Tab作为缩进，并设置缩进大小为4184.3代码注释18

4、4.4不得出现内嵌式代码184.5内联式代码占JavaScript的总量不得超过40%184.6外联式代码占JavaScript的总量至少为60%191.C#代码风格要求1.1注释类型、属性、事件、方法、方法参数，根据需要添加注释。如果类型、属性、事件、方法、方法参数的名称已经是自解释了，不需要加注释；否则需要添加注释。当添加注释时，添加方式如下图所示：1.2类型（类、结构、委托、接口）、字段、属性、方法、事件的命名优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。唯一可以使用中文

5、的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示：1.3不使用缩写所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg。1.4代码使用半展开第一步，打开VisualStudio，进入“工具”，“选项...”，如下图所示：第二步，进入“文本编辑器”，“C#”，“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示：第三步，点击“确定”，完成设置。1.5使用Tab作为缩进，并设置缩进大小为4第一步，打开VisualStudio，进入“工具

6、”，“选项...”，如下图所示：第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设置制表符。第三步，点击“确定”，完成设置。1.6一个.cs源文件至多定义两个类型如果两个类型的关系是紧密相关的，比如产品、产品类型，此时Product类，和ProductType枚举可以定义在同一个Product.cs文件中。但不能在一个.cs文件中出现两个不相关的类型定义，例如将Product类和Reseller类（分销商）定义在一个BasicInfo.cs文件中。1.7类型名称和源文件名称必须一致当类型命名为Pr

7、oduct时，其源文件命名只能是Product.cs。1.8所有命名空间、类型名称使用Pascal风格（单词首字母大写）如下图所示，红色标记的为使用Pascal风格的类型：注意ProductType是私有类型，不管类型是公有的还是私有的，其命名总是采用Pascal风格。1.9本地变量、方法参数名称使用Camel风格（首字母小写，其后每个单词的首字母大写）红色标记的为使用Camel风格的变量或者方法参数：1.10私有方法、受保护方法，仍使用Pascal风格命名示例代码如下：1.11如果if语句内容只有一行，可以不

8、加花括号，但是必须和if语句位于同一行范例1.9中的if判断实际上与下面的语句是等效的：1.12调用类型内部其他成员，需加this；调用父类成员，需加base示例代码如下：1.13类型内部的私有和受保护字段，使用Camel风格命名，但加“_”前缀代码示例如下：1.14不能出现公有字段如果需要公有字段，使用属性进行包装。1.15类型成员的排列顺序类型成员的排列顺序自上而下依次为：字段：私