淺析C#3.0編碼習(xí)慣與命名規(guī)則

作者：架構(gòu)人生 2009-03-11 10:06:42

本文通過一些建議簡單描述了程序員在使用C#3.0時(shí)應(yīng)具備的編碼習(xí)慣與命名規(guī)則

1.用Pascal規(guī)則來命名方法和類型。

public   class   DataGrid 
{ 
          public   void   DataBind() 
         { 
         } 
}

2.用Camel規(guī)則來命名局部變量和方法的參數(shù).

public class Product 
{ 
       private string _productId; 
       private string _productName; 
       public void AddProduct(string productId,string productName) 
       { 
       } 
}

3.所有的成員變量前加前綴“_”。

public class DataBase 
{ 
   private string _connectionString; 
}

4.接口的名稱加前綴 “I”。

public interface IConvertible 
{ 
    byte ToByte(); 
}

5.自定義的屬性以“Attribute”結(jié)尾。

public class TableAttribute:Attribute 
{

6.自定義的異常以Exception結(jié)尾。

public class NullEmptyException:Exception 
{

7.方法的命名。一般將其命名為動(dòng)賓短語。

public class File 
{ 
    public void CreateFile(string filePath) 
     {

     } 
     public void GetPath(string path) 
    {

    } 
}

#p#

8．局部變量的名稱要有意義。
不要用x，y，z等等，用For循環(huán)變量中可使用i, j, k, l, m, n。

public class User 
{ 
    public void GetUser() 
   { 
       string[] userIds={ "ziv ", "zorywa ", "zlh "};

       for(int i=0,k=userIds.Length;i       {

      } 
   } 
}

9．所有的成員變量聲明在類的頂端，用一個(gè)換行把它和方法分開。

public class Product 
{ 
     private string _productId; 
     private string _productName; 
     public void AddProduct(string productId,string productName) 
    {

    } 
}

10．用有意義的名字命名namespace，如：公司名、產(chǎn)品名。

namespace Zivsoft//公司命名 
{

} 
namespace ERP//產(chǎn)品命名 
{

11．建議局部變量在最接近使用它時(shí)再聲明。

12．使用某個(gè)控件的值時(shí)，盡量命名局部變量。

public string GetTitle() 
{ 
     string title=lbl_Title.Text; 
    return title; 
}

13.把引用的系統(tǒng)的namespace和自定義或第三方的用一個(gè)換行把它們分開

using System; 
using System.Web.UI; 
using System.Windows.Forms;

using CSharpCode; 
using CSharpCode.Style;

14.文件名要能反應(yīng)類的內(nèi)容，最好是和類同名，一個(gè)文件中一個(gè)類或一組關(guān)連類。

15.目錄結(jié)構(gòu)中要反應(yīng)出namespace的層次。

16.大括號 "{“要新起一行。

public Sample() 
{ 
     // 
     // TODO: 在此處添加構(gòu)造函數(shù)邏輯 
     // 
}

17. 普通get/set屬性，建議采用3.0的風(fēng)格：

public string Name
{
   get;
   set;
}

18. 局部變量，能用var，盡量使用var關(guān)鍵字。

19. 對象初始化，能簡寫最好簡寫：

var vt=new ValueText{Value=10, Text="Age"};

其實(shí)規(guī)則很重要，它是一種標(biāo)準(zhǔn)，可有可無，但有總會(huì)比無好，大家正在編碼的同志仔細(xì)看看，給點(diǎn)改進(jìn)意見，目前更新到19條。

【編輯推薦】

淺析C#中的套接字編程
詳解C# 4.0中必選參數(shù)與可選參數(shù)混合的問題
淺談C# 4.0中的動(dòng)態(tài)類型和動(dòng)態(tài)編程

責(zé)任編輯：book05 來源： cnblog

C#3.0 編碼習(xí)慣命名規(guī)則