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鍵,不要使用空格鍵。
關鍵字:ASP.NET、代碼、接口、規范
新文章:
- CentOS7下圖形配置網絡的方法
- CentOS 7如何添加刪除用戶
- 如何解決centos7雙系統后丟失windows啟動項
- CentOS單網卡如何批量添加不同IP段
- CentOS下iconv命令的介紹
- Centos7 SSH密鑰登陸及密碼密鑰雙重驗證詳解
- CentOS 7.1添加刪除用戶的方法
- CentOS查找/掃描局域網打印機IP講解
- CentOS7使用hostapd實現無AP模式的詳解
- su命令不能切換root的解決方法
- 解決VMware下CentOS7網絡重啟出錯
- 解決Centos7雙系統后丟失windows啟動項
- CentOS下如何避免文件覆蓋
- CentOS7和CentOS6系統有什么不同呢
- Centos 6.6默認iptable規則詳解