Net综合项目代码编写标准规范.doc

目录

TOC\o1-3\h\z\u1.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代码使用半展开

第一步，打开VisualStudio，进入“工具”，“选项...”，如下图所示：

第二步，进入“文本编辑器”，“C#”，“格式设立”，“新行”，取消掉右侧所有复选框中对号，如下图所示：

第三步，点击“拟定”，完毕设立。

1.5使用Tab作为缩进，并设立缩进大小为4

第一步，打开VisualStudio，进入“工具”，“选项...”，如下图所示：

第二步，进入“文本编辑器”，“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风格（首字母小写，其后每个单词首