程序编写规范

原文来源：《C#从入门到精通》

1、代码书写规范

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

1、尽量使用接口，然后使用类实现接口，以提高程序的灵活性。
2、一行不要超过80个字符
3、尽量不要手工更改计算机生成的代码，若必须修改，一定要改成和计算机生成的代码风格一样。
4、关键的语句（包括声明关键的变量）必须要写注释。
5、建议局部变量在最接近使用它的地方声明。
6、不要使用goto系列语句，除非是用在跳出深层循环时。
7、避免写超过5个参数的方法。如果要传递多个参数，则使用结构。
8、避免书写代码量过大的try…catch模块。
9、避免在同一个文件中放置多个类。
10、生成和构建一个长的字符串时，一定要使用StringBuilder类型，而不是string类型。
11、switch语句一定要有default语句来处理意外情况。
12、对于if语句，应该使用一对“{}”把语句块包含起来。
13、尽量不使用this关键字引用。

2、命名规范

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

public class DataGrid
{
    public void DataBind()
    {

    }
}

2、用Camel规则来命名局部变量和方法的参数，该规则是指名称中第一个单词的第一个字母小写。

string strUserName;

3、所有的成员变量前加前缀“_”。

public class DataBase
{
    private string _connectionString;    //声明一个私有成员变量
}

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

public interface Iconvertible
{
    byte ToByte();
}

5、方法的命名，一般将其命名为动宾短语。

public class File
{
    public void CreateFile(string filePath)
    {
    }
    public void GetPath(string path)
    {
    }
}

6、所有的成员变量声明在类的顶端，用一个换行把它和方法分开。

public class Product
{
    private string _productId;           //在类的顶端声明变量
    private string _productName;         //在类的顶端声明变量

    public void AddProduct(string productId, string poductName)
    {
    }
}

注意：在类中定义私有变量和私有方法，变量和方法只能在该类中使用，不能对类进行实例化，也不能对其进行调用。

7、用有意思的名字命名 命名空间，如公司名，产品名。

namespace Zivsoft        //公司命名
{
}
namespace ERP             //产品命名
{
}

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

public string GetTitle()
{
    string title = lbl_Title.Text;    //定义一个局部变量
    return title;                     //使用这个局部变量
}