C#程序规范_c#编程规范

1.代码书写规则

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

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

2.尽量不要手工更改计算机生成的代码，如必须修改，则要改成与计算机风格一致的代码。

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

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

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

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

7.避免书写代码量过大的try-catch代码块。

8.避免在一个文件内放多个类。

9.生成和构建一个长的字符串时，一定要使用StringBuilderl类型，而不用String类型。

10.swtich语句要有default语句来处理意外情况。

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

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

2.命名规范

命名规范在编写代码时起到很重要的作用，虽然不遵循命名规范，但是程序还是可以运行，但是使用命名规范可以直观地了解代码的含义。下面列出一些命名规范，供参考。

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

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

public class User            //创建一个公共类User
{
    public void Getinfo()    //声明一个公共方法Getinfo
    {
    }
}

2.用Camel规则来命名局部变量和方法的参数，Camel规则时指名称中第一个单词的字母小写，并且后面连接词的第一个字母均为大写。

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

string strUserName;                                        //声明一个字符串变量strUserName
public void addUser(string strUserId,byte[] byPassword)    //创建一个具有两个参数的公共方法

3.所有的成员变量前加“_”

例如，在公共类DateBase中声明一个私有变量_connectionString,代码如下

public calss DateBase                            //创建一个公共类DateBase
{
    pritvate string_connectionString;            //声明一个私有变量connectionString
 
}

4.接口的名称加后缀“I”

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

string interface Iconvertible        //声明一个公共接口iconvertible
{
    byte toByte();            //声明一个byte类型方法
}

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

例如在公共类File中创建一个creatFile()方法和GetPath()方法，代码如下

public class File                             //创建一个公共类file
{
    public void CrateFile(string filePath)    //创建一个公共createfile方法
    {
                                            
    }
    public void GetPath(string path)          //创建一个公共getpath()方法
    {
    }
}

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

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

public class Product            //创建一个公共类
{
    public string_productId;    //在类的顶端声明变量
    public string_productName;  //在类的顶端声明变量
    //创建一个公共方法
    public void Addproduct(string productId,string productName)
    {
    }
}

tips，

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

7.用有意义的名字来命名空间namespace，如公司名，产品名。

例如，利用公司名和产品名来命名空间namespace，代码如下

namespace ywd compony        //公司名
{
}
nemespace gtx1650            //产品名

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

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

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

tips2

在定义有返回值的方法时，必须在设置方法时，定义方法的类型，并在方法体结束后用return返回值。