ASP.NET程式設計中的9條程式碼編寫規範

寫了這麼久程式程式碼了，發現很多人的程式碼很不規範。尤其在幾個人協作開發一個專案的時候，有些人寫的類名、變數名、方法等令人根本看不懂，可能會弄的整個專案都沒法組合完成。自認為我的寫的程式碼已經很不錯了，至少能夠見名知意。不過，看完這9條後我覺得我還得進一步學習學習了...

　　1.區域性變數的名稱要有意義，儘量用對應的英文命名，比如“使用者姓名”變數，不要用aa bb cc等來命名，而要使用userName。

　　2.不要使用單個字母的變數，如i、n、x等。而要使用index、temp等。用於迴圈迭代的變數例外。

　　3.應該使用Pascal命名法命名方法名、屬性名、類名和名稱空間，且方法的命名一般將其命名為動賓短語，如

以下為引用的內容：

◆ShowDialog();

◆CreateFile();

◆GetPath();

　　4.用Camel命名法命名區域性變數和方法的引數。

以上幾條綜合舉例如下：

以下為引用的內容：

public class Neeke
{
    public Neeke()
    {
        
    }
 
    private string neekeName;
 
    public string NeekeName
    {
        get { return neekeName; }
        set { neekeName = value; }
    }
 
    public void CallMe()
    {
        System.Console.WriteLine("Hello Neeke!");
    }
}

　　5.僅使用匈牙利命名法對WinForm和Web空間命名，禁止使用textbox1、gridview1等預設命名。

　　6.介面命名以大小寫I作為字首，如INeeke，以便直觀的區分介面和類。

　　7.使用名稱空間的層次性結構來組織各種類和介面。

正確：

以下為引用的內容：

using Www.Ineeke.Cn;
namespace Ineeke.Cn
{
 ...
}

錯誤：

以下為引用的內容：

using WwwIneekeCn;

namespace IneekeCn

{
 ...

}

　　8.所有程式碼必須保證有足夠的註釋，註釋量要求在15%以上。需要註釋的內容包括以下幾種。

　　1）關鍵性語句（如關鍵的變數宣告，條件判斷等）。

　　2）類名前的文件註釋（以//開頭的註釋）包括類的簡單功能說明、使用方法等。

　　3）具有複雜引數列表的方法。

　　9.程式碼縮排用Tab鍵，不要使用空格鍵。

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/12639172/viewspace-545260/，如需轉載，請註明出處，否則將追究法律責任。