2.3　程序编写规范

编写代码时，需要遵循一定的代码书写规则和命名规范，使程序代码更加规范化。

2.3.1　代码书写规则

养成良好的编码习惯，对于软件开发和后续维护都非常有益，下面介绍常见的代码书写规则。

　尽量使用接口，然后使用类实现接口，以提高程序的灵活性。

　尽量不要手工更改计算机生成的代码，若必须更改，一定要改成和计算机生成的代码风格一样。

　关键的语句（包括声明关键的变量）必须要写注释。

　建议局部变量在最接近使用它的地方声明。

　不要使用goto系列语句，除非是用在跳出深层循环时。

　避免书写超过5个参数的方法。如果要传递多个参数，则使用结构。

　避免书写代码量过大的try…catch代码块。

　避免在同一个文件中放置多个类。

　生成和构建一个长的字符串时，一定要使用StringBuilder类型，而不用string类型。

　switch语句一定要由default语句来处理意外情况。

　对于if语句，应该使用一对“{}”把语句块包含起来。

　尽量不使用this关键字引用。

2.3.2　命名规范

虽然不遵循命名规范，程序也可以运行，却会降低代码的可理解性。下面列出一些命名规范，供读者参考。

（1）采用Pascal规则命名方法和类型，即首字母必须大写，后续连接词的首字母均为大写。

例如，定义一个公共类，并在此类中创建一个公共方法，代码如下。

     public class User          //创建一个公共类
     {
         public void GetInfo()  //在公共类中创建一个公共方法
         {
         }
     }

（2）采用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()方法，代码如下。

（6）将成员变量声明在类的顶端，用换行把它和方法分开。

例如，在类的顶端声明两个私有变量_productId和_productName，代码如下。

（7）用有意义的名字建立命名空间，如公司名、产品名。例如，利用公司名和产品名建立命名空间，代码如下。

（8）使用某个控件的值时，尽量命名局部变量。

例如，创建一个方法，声明一个字符串变量title，使其等于Label控件的Text值，代码如下。