国内大公司内部的 C# 编程规范

C#编程规范

 

 

 

 

修改记录

Ver. No	发版日期	编制人	批准人	修改的说明

目   录

1    前言...4

1.1     参考资料...4

1.2     词汇表...4

2    命名指南...4

2.1     大写样式...4

2.1.1      Pascal 大小写...5

2.1.2      Camel 大小写...5

2.1.3      大写...5

2.2     区分大小写...6

2.3     缩写...7

2.4     措词...7

2.5     命名Namespace指南...8

2.6     类命名指南...9

2.7     接口命名指南...10

2.8     Attribute命名指南...11

2.9     枚举类型命名指南...11

2.10       私有Field的命名。...11

2.11    Internal或者Public命名指南...12

2.12       参数命名指南...12

2.13       方法命名指南...13

2.14   Property命名指南...13

2.15   Event命名指南...15

2.16       关于控件的命名...16

2.17       局部变量的命名...17

2.18       常用变量和参数的命名...17

3    aspx文件中Client端脚本处理的相关规范...20

3.1     声明全局变量theForm..20

3.2     WindowOnload事件...20

3.3     弹出对话框的返回值处理代码的编写...21

3.4     对Toolbar的Click事件的响应...21

3.5     JavaScript中的命名约定...22

3.5.1      函数命名...22

3.5.2      变量命名...23

3.5.3      循环的写法...23

3.6     弹出对话框的写法...23

4    代码格式...24

4.1     注释...24

4.1.1      文件头部注释...24

4.1.2      方法、属性的注释...24

4.2     空行划分...25

4.2.1      函数间要用空行分开...25

4.2.2      用空行将代码按逻辑片断划分...25

4.2.3      函数返回语句要和其他语句用空行分开...25

4.3     花括号的使用...26

4.4     使用花括号进行段落划分...26

4.4.1      花括号{}要独占一行...26

4.4.2      花括号中没有或者只有一条语句时，也不省略花括号...26

4.5     不要在一行中放多于一条语句...27

4.6     长行拆分...27

4.6.1      Sql语句的分行...27

4.6.2      if判断表达式的分行...27

4.6.3      方法调用的分行...28

4.6.4      多参数方法的分行...28

 

1  前言

本规范包括两个个部分：“命名规范”、“代码格式”。

 

编写此规范的目的是，为大家编写清晰、易读的代码提供良好的建议。也为公司的代码审阅提供一个可供参考的标准。

 

1.1参考资料

       C#编码规范的主要内容来自于MSDN中《Design Guidelines for Class Library Developers》，其次是摩托罗拉（中国）电子有限公司陈世忠编著的《C++编码规范》。另外，也参考了作者主持反编译的ASP .net源码、Microsoft公开源码的.NET平台实现Rotor的系统类库、ErichGamma</