年前整理的C#规范

年前，领导让整理下简单的编程规范，不用太细致，主要是统一开发人员的编码风格。一共3份，分别为C#,Js,CSS。其中有自己的心得，也有部分从网上搜来的。

C#编码规范

一，基本约定

1. 所有的命名名称都必须使用能直接体现具体含义的名字。不能使用x,y,z等无意义的名称进行定义，循环变量除外。

2. 所有的成员变量必须在所有成员方法前面声明，用一个换行把它和方法分开

3. switch语句一定要有default来处理意外情况。

4. 同程序外部连接（如连接数据库、接口、文件等）一定要捕获任何类型的异常（try）给出友好的消息给用户，必要时用日志记录错误的细节，包括发生的时间，和相关方法，类名等。

5. 不在代码中使用具体的路径和驱动器名，必须使用相对路径。

6. 代码的缩进用Tab，而不要用space。

7. 一个方法只完成一个任务。不要把多个任务组合到一个方法中。

8. 避免使用大文件。如果一个文件里的代码超过300～400行，可考虑将代码分开到不同类中。

9. 重要变量必须有注释。  

10. 注意todo的运用 

二，命名规范

1. 常量 全部大写，单词之间以 “_” 分隔，例：USER_PASSWORD。

2. 类  采用Pascal命名规则

3. 方法 采用Pascal命名规则，一般将其命名为动宾短语

4. 成员变量 与类命名规则相同，私有变量首字母小写或加小写前缀。

5. 其它可遵循ReSharper的编码规范

三，注释规范

1、 注释必须使用中文及中文的标点符号, 每行注释的最大长度不能超过1024*800或者常用的屏幕的宽度 

2、 文件必须有注释

3、 典型算法必须有注释。  

4、 在循环和逻辑分支的地方必须写上注释。  

5、 程序段或语句的注释在程序段或语句的上一行。