1. 命名
1). 变量:一般使用名词,首字母小写,从第二个单词开始大写 ;常量全部大写。例如:int name;finna int USERNAME
2). 方法: 一般使用动词,命名要有意义,每个单词首字母大写。例如:GetUserName()
3). 类:一般使用名词、形容词,每个单词首字母大写。例如:SqlHelper
4). 接口:一般使用名词、形容词,每个单词首字母大写,并且以“I”为前缀。例如:ISqlHelper
5). 命名空间:每个单词首字母大写,遵循“项目类型.公司名称.项目名称.XXX”规则,例如:Com.Microsoft.Sql.Data---com代表是web类型,Microsoft代表微软公司,Sql代表项目名称是Sql,Data才是空间名称。如果是winform项目,可以使用Win来标注。
6). 所有命名要有意义,不要使用a,b,c之类无意义命名
2. 空格,空行
1). 申明类大括号后面紧跟空行
2). 方法开头和结尾各空一行,方法之间使用空行
3). try...catch开头和结尾各空一行
4). return前面空一行
5). =号两边各空一格
6). ()和if,while,catch等语句在一起时,与符号之间空一格
3. 特殊规则
1). {}大括号要成对出现,并出现在相同竖直位置
2). 制表位对齐时使用软Tab键,即4个空格大小,VS工具可以设置。
3). 申明变量时,不要在同一行同时申明2种类型相同的变量。例如:int a,b; ---- 不推荐 int a; int b; ---- 推荐
4). 任何一个方法体不要超过40行,职能尽量单一;同理,类的职责也要单一,一般一个类不要超过400行
5). 申明变量时,采用字母顺序依次申明。例如:string name; string pwd;string id; ----不推荐 string id; string name; string pwd; ----推荐
6). 注释要明确,针对方法和类的注释采用文档注释,不要使用//来注释