ASP.NET代碼編寫規範

來源:互聯網
上載者:User

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



相關文章

Beyond APAC's No.1 Cloud

19.6% IaaS Market Share in Asia Pacific - Gartner IT Service report, 2018

Learn more >

Apsara Conference 2019

The Rise of Data Intelligence, September 25th - 27th, Hangzhou, China

Learn more >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。