1.
类的私有成员变量必须以m_开头,而且其后的内容必须与相对应的属性名相同,也就是说第一个字母必须大写;
2.
属性实现中的Get和Set方法的内容不可写在一行中,“{”必须写在第二行;
3.
每一段程序与下一段程序之间必须且只能有一行空行;
4.
using部分的内容必须进行分段,相同的内容放到一段中,现在可以参考的规则是:System放到一块,MicroSoft放到一块,Newegg放到一块,各个块之间要加一行空行,而且相同的内容要尽量放到一块,例如System要和System.Data要放到一块;
5.
类的私有成员变量定义要放到类的最前面,且之间不需要加空行;
6.
文件头的注释格式要统一,现在的格式统一为:
/*******************************************************************************
** File Name:
文件名
** Creator:
短名
** Create date:
日期
** Latest Modifier:
** Latest Modify date:
** Description:
** Modify History:
**
** Code Review:
**
** Version number: 1.0.0
*********************************************************************************/
注释的上部没有空行,注释的下部要与 using之间有一行空行;
7.
实体类和接口中不需要注释,除非非常有必要说明;
8.
文件名必须与主体类的名称相同;
9.
对于相同功能的变量,名称必须一致;
10.
在一个类中,如果没有非常的必要,不要加region;
11.
操作符的两边必须要加一个且只能加一个空格,包括:;
12.
枚举必须单独定义一个类,且必须单独放在一个文件中,可以烤炉建立一个Enum目录,将所有的枚举类放到这个目录下;
13.
定义的枚举类型必须显示的指定枚举的类型和每一个枚举的数值;
14.
每一个属性或方法的属性定义(
DataContract
,DataMember,DataMapping,EnumMember,ServiceContract,OperationContract等等)必须与定义相连,不许有空行;
15.
DataMaping放在DataMember的上方;
16.
定义实体类时私有变量的顺序尽量与属性的顺序一致;
17.
每一个方法要加注释,注释在方法之上,与方法相连,之间没有空行;
18.
每一次代码修改尽量加注释;
19.
在CheckIn时,必须加注释;
20.
在try catch中定义Exception的变量名称一律用ex;
21.如果返回值是
List
类型,则不可返回
Null
;