新手應知道的ASP.NET代碼編寫規範

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鍵，不要使用空格鍵。