2.3　程序编写规范

下面给出两段实现同样功能的代码，如图2.14所示。

大家在学习时，愿意看图2.14中的左侧代码还是右侧代码？答案应该是肯定的，大家肯定都喜欢阅读图2.14中的右侧代码，因为它看上去更加规整，这是一种最基本的代码编写规范。本节将对C#代码的编写规则以及命名规范进行介绍。遵循一定的代码编写规则和命名规范可以使代码更加规范化，对代码的理解与维护起到至关重要的作用。

2.3.1　代码编写规则

代码编写规则通常对应用程序的功能没有影响，但它们对于改善对源代码的理解是有帮助的。养成良好的习惯对于软件的开发和维护都是很有益的，下面列举一些常用的代码编写规则。

• 编写C#程序时，统一代码缩进的样式，例如统一缩进两个字符或者4个字符位置。
• 每编写一行C#代码，都应该换行编写下一行代码。
• 在编写C#代码时，应该合理使用空格，以便使代码结构更加清晰。
• 尽量使用接口，然后使用类实现接口，以提高程序的灵活性。
• 关键的语句（包括声明关键的变量）必须要写注释。
• 建议局部变量在最接近使用它的地方声明。
• 不要使用goto系列语句，除非是用在跳出深层循环时。
• 避免编写超过5个参数的方法，如果要传递多个参数，则使用结构。
• 避免书写代码量过大的try-catch语句块。
• 避免在同一个文件中编写多个类。
• 生成和构建一个长的字符串时，一定要使用StringBuilder类型，而不用string类型。
• 对于if语句，应该使用一对“{ }”把语句块包含起来。
• switch语句一定要由default语句来处理意外情况。

2.3.2　命名规范

命名规范在编写代码中起到很重要的作用，虽然不遵循命名规范，程序也可以运行，但是使用命名规范可以更加直观地了解代码所代表的含义。本节将介绍C#中常用的一些命名规范。

1. 两种命名方法

在C#中，最常用的有两种命名方法，分别是Pascal命名法和Camel命名法，下面分别介绍。

• 用Pascal命名法来命名方法和类型。Pascal命名法规定第一个字母必须大写，并且后面连接词的第一个字母均为大写。

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

• 用Camel命名法来命名局部变量和方法的参数。Camel命名法规定指名称中第一个单词的第一个字母小写。

例如，声明一个字符串变量和创建一个公共方法，代码如下：

2. 程序中的命名规范

开发项目时，不可避免地会遇到各个程序元素的命名问题，例如项目的命名、类的命名、方法的命名等，如图2.15中声明了一个User类，图2.16中声明了一个aaa类。

查看图2.15和图2.16，从类的命名上，可以很容易看出，图2.15中的User类应该是与用户相关的一个类，但是图2.16中声明的aaa类，即使再有想象力的人，恐怕也想象不出这个类到底是做什么用的吧？从这两个例子可以看出，在对程序元素命名时，如果遵循一定的规范，将使代码更加具有可读性，下面介绍一下常用程序元素的基本命名规范。

• 命名项目名称时，可以使用公司域名+产品名称，或者直接使用产品名称。

例如，利用公司名和产品名定义命名空间，在命名项目时，可以将项目命名为“mingrisoft.ERP”或者“ERP”，其中，mingrisoft是公司的域名，ERP是产品名称。

• 用有意义的名字定义命名空间，如公司名、产品名。

例如，利用公司名和产品名定义命名空间，代码如下：

接口的名称加前缀“I”。

例如，创建一个公共接口Iconvertible，代码如下：

类的命名最好能够体现出类的功能或操作。

例如，创建一个名称为Operation的类，用来作为运算类，代码如下：

方法的命名：一般将其命名为动宾短语，表明该方法的主要作用。

例如，在公共类File中创建CreateFile方法和GetPath方法，代码如下：

定义成员变量时，最好加前缀“_”。

例如，在公共类DataBase中声明一个私有成员变量_connectionString，代码如下： SOIdv/W+tjV00ojupQ/XUzKGCeBv7YeSi5wcFKd9k4S9lA1YQomLgqrMZOn20yF6