C#编程规范--命名篇
1.用pascal规则来命名方法和类.(第一个单词首字母大写,后面连接的每个单词首字母都大写)
public class DataBase ;public void GetDataTable()
2.用camel规则来命名局部变量和方法的参数. (第一个单词不大写,后面连接的单词首字母大写)
public void AddUser(string userId, byte[] password)
{ string userName;}
3.所有的成员变量前加前缀 _
public class Database
{ private string _connectionString; }
4.接口的名称加前缀 I
interface ICompare
{ int compare(); }
5.自定义代码属性类以Attribute结尾
public class OperationAttribute : Attribute
6.自定义的异常以Exception结尾
public class AppException : Exception
7.方法的命名.一般将其命名为动宾短语.
GetRecordData();GetPath();CreateFile();
8.代码的缩进.要用Tab,而不要用space.
9.局部变量的名称要有意义.不要用x,y,z等等(除用于For循环变量中可使用i,j,k,l,m,n).
10.所有的成员变量声明在类的顶端,用一个换行把它和方法分开.
11.用有意义的名字命名namespace,如:产品名、公司名.
12.建议局部变量在最接近使用它时再声明.
13.使用某个控件的值时,尽量命名局部变量.
14.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开.
15.文件名要能反应类的内容,最好是和类同名,一个文件中一个类或一组关连类.
16.目录结构中要反应出namespace的层次.
17.大括号"{"要新起一行
public class DataBase ;public void GetDataTable()
2.用camel规则来命名局部变量和方法的参数. (第一个单词不大写,后面连接的单词首字母大写)
public void AddUser(string userId, byte[] password)
{ string userName;}
3.所有的成员变量前加前缀 _
public class Database
{ private string _connectionString; }
4.接口的名称加前缀 I
interface ICompare
{ int compare(); }
5.自定义代码属性类以Attribute结尾
public class OperationAttribute : Attribute
6.自定义的异常以Exception结尾
public class AppException : Exception
7.方法的命名.一般将其命名为动宾短语.
GetRecordData();GetPath();CreateFile();
8.代码的缩进.要用Tab,而不要用space.
9.局部变量的名称要有意义.不要用x,y,z等等(除用于For循环变量中可使用i,j,k,l,m,n).
10.所有的成员变量声明在类的顶端,用一个换行把它和方法分开.
11.用有意义的名字命名namespace,如:产品名、公司名.
12.建议局部变量在最接近使用它时再声明.
13.使用某个控件的值时,尽量命名局部变量.
14.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开.
15.文件名要能反应类的内容,最好是和类同名,一个文件中一个类或一组关连类.
16.目录结构中要反应出namespace的层次.
17.大括号"{"要新起一行