C#命名规则和编码规范,让你的代码变得优美
话不多说,直接上干货
属性、方法、事件和类名使用Pascal规则来命名
- Pascal规则是指名称中单词的首字母大写 ,如EmployeeSalary、 ConfimationDialog、PlainTextEncoding
public class HelloWorld{ public void SayHello(string name) { }}
成员变量、局部变量和方法的参数使用Camel规则来命名
- Camel规则类似于Pascal规则 ,但名称中第一个单词的首字母不大写 ,如employeeSalary、 confimationDialog、plainTextEncoding。
- 不要给成员变量加任何前缀(如m、s_、_ 等)。如果想要区分局部变量和成员变量,可以使用this关键字。
public class Product{ private string productId; private string productName; public void AddProduct(string productId,string productName) { }}
常量或者只读变量的变量名使用Pascal规则来命名
- 不要将常量或者只读变量全部大写。
// 建议public static const string ShippingType = 'DropShip';// 不建议public static const string SHIPPINGTYPE = 'DropShip';
接口的名称一般以大写I作前缀
public interface IConvertible{ byte ToByte();}
自定义的属性以Attribute结尾。
public class TableAttribute:Attribute{}
自定义的异常以Exception结尾。
public class NullEmptyException:Exception{}
类的命名。用名词或名词短语来命名类名。
方法的命名。一般将其命名为动宾短语。
public class File{ public void CreateFile(string filePath) { } public void GetPath(string path) { }}
可以用缩写作为UI元素的前缀。常见UI组件的一般缩写形式:
Label --> lbl、Text --> txt、Button --> btnImage --> img、 Widget --> Wgt、 List --> lst、CheckBox --> chkHyperlink --> lnk、Panel --> pnl、Table --> tabImageButton --> imb
布尔型变量或者方法一般可以用is、can或者has做前缀。如,isFinished, canWork等。
- 判断条件是一个布尔变量时不要使用==进行条件判断。
// 建议private bool isFinished = true;if(isFinished){}// 不建议private bool isFinished = true;if(isFinished == true){}
变量名是一个单词的尽量不要缩写,多个单词组成的变量名可适当缩写。
在类的顶部声明所有的成员变量,静态变量生命在最前面。
public class Account{ public static string BankName; public static decimal Reserves; public string Number {get; set;} public DateTime DateOpened {get; set;} public DateTime DateClosed {get; set;} public decimal Balance {get; set;} // Constructor public Account() { }}
其他
- 局部变量的名称要有意义。
- 不要直接用用i,j,k,l,m,n,x,y,z等做变量名,但for循环除外。
- 所有的成员变量声明在类的顶端,用一个换行把它和方法分开。同时可以使用成对的#region...#endregion标记,方便折叠。
- 一般C#的编码风格要求花括号“{”另起一行,不要直接跟在类名和方法后面。
- 如果一个方法超过25行,就需要考虑是否可以重构和拆分成多个方法。
- 方法命名要见名知意,好的方法名可以省略多余的注释。方法功能尽量单一。
赞 (0)