.Net项目代码编写规范.docVIP

目录 1. C# 代码风格要求 3 1.1注释 3 1.2 类型（类、结构、委托、接口）、字段、属性、方法、事件的命名 3 1.3 不使用缩写 4 1.4 代码使用半展开 4 1.5 使用Tab作为缩进，并设置缩进大小为4 5 1.6 一个.cs源文件至多定义两个类型 7 1.7 类型名称和源文件名称必须一致 7 1.8 所有命名空间、类型名称使用Pascal风格（单词首字母大写） 7 1.9 本地变量、方法参数名称使用Camel风格（首字母小写，其后每个单词的首字母大写） 7 1.10 私有方法、受保护方法，仍使用Pascal风格命名 8 1.11 如果if语句内容只有一行，可以不加花括号，但是必须和if语句位于同一行 8 1.12 调用类型内部其他成员，需加this；调用父类成员，需加base 9 1.13 类型内部的私有和受保护字段，使用Camel风格命名，但加“_”前缀 9 1.14 不能出现公有字段 10 1.15 类型成员的排列顺序 10 1.16 委托和事件的命名 11 1.17 返回bool类型的方法、属性的命名 11 1.18 常见集合类型后缀命名 12 1.19 常见后缀命名 12 1.20 常见类型命名 13 1.21 常见字段、属性命名 14 2. XHTML 代码风格要求 14 2.1 如果XHTML标记有层次，那么代码也要有层次 14 2.2 所有标记必须闭合 15 2.3 如果标记中间代码超过20行，则应在标记末尾加注标识 15 3. CSS 代码风格要求 16 3.1 代码使用半展开 16 3.2 使用Tab作为缩进，并设置缩进大小为4 16 3.3 代码注释 16 3.4 代码编写 16 3.5 嵌入式样式的比例不超过样式表代码总量的10% 17 3.6 内联式样式的比例不超过样式表代码总量的30% 17 3.7 外联式样式表的比例不少于样式表代码总量的60% 17 4. JavaScript 代码风格要求 18 4.1 代码使用半展开 18 4.2 使用Tab作为缩进，并设置缩进大小为4 18 4.3 代码注释 18 4.4 不得出现内嵌式代码 18 4.5 内联式代码占JavaScript的总量不得超过40% 18 4.6 外联式代码占JavaScript的总量至少为60% 19 1. C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数，根据需要添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了，不需要加注释；否则需要添加注释。 当添加注释时，添加方式如下图所示： 1.2 类型（类、结构、委托、接口）、字段、属性、方法、事件的命名 优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。 唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示： 1.3 不使用缩写 所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg。 1.4 代码使用半展开 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示： 第三步，点击“确定”，完成设置。 1.5 使用Tab作为缩进，并设置缩进大小为4 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设置制表符。 第三步，点击“确定”，完成设置。 1.6 一个.cs源文件至多定义两个类型 如果两个类型的关系是紧密相关的，比如 产品、产品类型，此时Product类，和ProductType枚举可以定义在同一个Product.cs文件中。 但不能在一个.cs文件中出现两个不相关的类型定义，例如将 Product类和Reseller类（分销商）定义在一个BasicInfo.cs文件中。 1.7 类型名称和源文件名称必须一致 当类型命名为Product时，其源文件命名只能是Product.cs。 1.8 所有命名空间、类型名称使用Pascal风格（单词首字母大写） 如下图所示，红色标记的为使用Pascal风格的类型： 注意ProductType是私有类型，不管类型是公有的还是私有的，其命名总是采用Pascal风格。 1.9 本地变量、方法参数名称使用Camel风格（首字母小写，其后每个单词的首字母大写） 红色标记的为使用Camel风格的变量或者方法参数： 1.10 私有方法、受保护方法，仍使用Pascal风格命名 示例代码如下： 1.11 如果if语句内容只有一行，可以不加花括号，但是必须和if语句位于同一行