A.代码书写规则
代码书写规则通常对应用程序的功能没有影响,但它们对于改善对源代码的理解是有帮助的。
养成好的习惯对于软件的开发和维护都是有益的,下面介绍一些代码书写规则。
1.尽量使用接口,然后使用类实现接口,以提高程序的灵活性。
2.尽量不要手工更改计算机生成的代码,若必须要改,一定要改成和计算机生成的代码风格一样。
3.关键的语句(包括声明关键的变量)必须要写注释。
4.建议局部变量在最接近使用它的地方声明。
5.不要使用goto系列语句,除非是用在跳出深层次循环时。
6.避免写超过5个参数的方法,如果要传递多个参数,则使用结构。
7.避免书写代码量过大的try-catch代码块。
8.避免在同一个文件中放置多个类。
9.生成和结构一个长的字符串时,一定要使用StringBuilder类型,而不是string类型。
10.switch语句一定要有default语句来处理意外情况。
11.对于if语句,应该使用一对 “{ }” 把语句块包含起来。
12.尽量不要使用this关键字引用。
B.命名规范
命名规范在编写代码中起到很重要的作用,虽然不遵循命名规范,程序也可以运行,但是使用命名规范可以很直观地了解代码所代表的含义。
下列一些命名规范可供参考:
1.用Pascal规范来命名方法和类型,Pascal的命名规范是第一个字母必须大写,并且后面的连接语词的第一个字母均为大写。
例:定义一个公共类,并且在此类中创建一个公共方法
public class User //创建一个公共类 { public void Getinfo() //在公共类中创建一个公共方法 { } }
2.用Camel规范来命名局部变量和方法的参数,Camel规范是指名称中第一个单词的第一个字母小写,并且后面的连接词的第一个字母均为大写。
例:声明一个字符串变量和创建一个公共方法。
string strUserName; //声明一个字符串变量strUserName; public void addUser(string strUserId, byte[] byPassword); //创建一个具有两个参数的公共方法;
3.所有的成员变量前加前缀 “_”。
例:在公共类DataBase中声明一个私有成员变量_connectionString。
public class DataBase //创建一个公共类 { private string _connectionString; //声明一个私有成员变量 }
4.接口的名称加前缀 “ I ”。
例:创建一个公共接口 Iconvertible。
public interface Iconvertible //创建一个公共类接口 Iconvertible { byte ToByte(); //声明一个byte类型的方法 }
5.方法的命名,一般将其命名为动宾短语。
例:在公共类 File 中创建 CreateFile() 方法和 GetPath() 方法。
public class File //创建一个公共类 { public void CreateFile(string filePath) //创建一个CreathFile()方法 { } public void GetPath(string path) //创建一个GetPath()方法 { } }
6.所有的成员变量声明在类的顶端,用一个换行把它和方法分开。
例:在类的顶端声明两个私有变量_productId 和 _productName。
public class Product //创建一个公共类 { private string _productId; //在类的顶端声明变量 private string _productName; //在类的顶端声明变量 public void AddProduct(string productId, string productName) { } }
注意:在类中定义私有变量和私有方法,变量和方法只能在该类中使用,不能对类进行实例化,对其进行调用。
7.用有意义的名字命名空间namespace,如公司名、产品名。
例:利用公司名和产品名命名空间namespace。
namespace Zivsoft //公司命名 { } namespace ERP //产品命名 { }
8.使用某一个控件的值时,尽量命名局部变量。
例:创建一个方法,在方法中声明一个字符串变量title,使其等于Label控件的Text值。
public string GetTitle() // 创建一个公共方法 { string title = IbI_Title.Text; //定义一个局部变量 return title; //使用这个局部变量 }
在定义有返回值的方法时,必须在设置方法时,定义方法的类型,并在方法结束后用 return 返回值。
C.总结
本章主要介绍了C#代码书写规范,在编写程序代码时,要养成一个良好的编码习惯。
谢谢。