字乃人之衣冠,代码命名乃程序员之衣冠。良好的代码命名规范,代表着对自己作品和对自己工作的态度。下面谈谈C#代码命名规范。
C#常见的代码命名规范有:
1、骆驼命名法(camelCase)
是指混合使用大小写字母来构成变量和函数的名字,例如
printOrderList()
2、Pascal命名法
其实Pascal命名法与骆驼命名法类似。只不过骆驼命名法是首字母小写,而帕斯卡命名法是首字母大写,例如
PrintOrderList()
C#常用的命名法就是上面两样了。
当然,程序世界里面还有很多其他的命名规则,例如:“匈牙利命名法”,“下划线命名法”。但用于C#不多见,所以不讨论了。
下面直接列举两种命名方法的应用例子,一看就能明白~
命名空间 namespace Pascal 以.分隔,其中每一个限定词均为Pascal命名方式 如Com.Real.FrameWork
类 class Pascal 例:public class MyOrderInfo 接口 interface Pascal 每一个逻辑断点首字母大写,总是以I前缀开始,后接Pascal命名,如:public interface IUserAccount
方法 method Pascal 每一个逻辑断点首字母大写,如:private void SetMember(string name)
枚举类型 enum
Pascal 每一个逻辑断点首字母大写 委托 delegate
Pascal 每一个逻辑断点首字母大写
局部变量
Camel 如:string myName;
方法的参数 Camel void GetUserInfo(string userCode)
另外,还有一些有关代码规范的建议:
1、成员变量前加前缀 _
2、接口的名称加前缀I
3、自定义的属性以Attribute结尾,如:
public class AuthorAttribute :Attribute{}
4、自定义的异常以Exception结尾,如:
public class AppException: Exception{}
5、方法的命名。一般将其命名为动宾短语,如:
ShowDialog()
CreateFile()
6、代码的缩进。要用Tab,而不要用space.
7、局部变量的名称要有意义。不要用x,y,z等等(除用于For循环变量中可使用i,j,k,l,m,n)。
8、所有的成员变量声明在类的顶端,用一个换行把它和方法分开。
9、用有意义的名字命名namespace,如:产品名、公司名。
10、生成和构建一个长的字符串时,一定要使用StringBuilder,而不用string。
11、始终使用”{ }”包含if下的语句,即使只有一条语句。
12、把相似的内容放在一起,比如数据成员、属性、方法、事件等,并适当的使用#region…#endregion