ASP.NET應(yīng)該遵守的9條代碼編寫(xiě)規(guī)范
寫(xiě)了這么久程序代碼了,發(fā)現(xiàn)很多人的代碼很不規(guī)范。尤其在幾個(gè)人協(xié)作開(kāi)發(fā)一個(gè)項(xiàng)目的時(shí)候,有些人寫(xiě)的類(lèi)名、變量名、方法等令人根本看不懂,可能會(huì)弄的整個(gè)項(xiàng)目都沒(méi)法組合完成。自認(rèn)為我的寫(xiě)的代碼已經(jīng)很不錯(cuò)了,至少能夠見(jiàn)名知意。不過(guò),看完這9條后我覺(jué)得我還得進(jìn)一步學(xué)習(xí)學(xué)習(xí)了...
1.局部變量的名稱(chēng)要有意義,盡量用對(duì)應(yīng)的英文命名,比如“用戶姓名”變量,不要用aa bb cc等來(lái)命名,而要使用userName。
2.不要使用單個(gè)字母的變量,如i、n、x等。而要使用index、temp等。用于循環(huán)迭代的變量例外。
3.應(yīng)該使用Pascal命名法命名方法名、屬性名、類(lèi)名和命名空間,且方法的命名一般將其命名為動(dòng)賓短語(yǔ),如
◆ShowDialog();
◆CreateFile();
◆GetPath();
4.用Camel命名法命名局部變量和方法的參數(shù)。
以上幾條綜合舉例如下
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.僅使用匈牙利命名法對(duì)WinForm和Web空間命名,禁止使用textbox1、gridview1等默認(rèn)命名。
6.接口命名以大小寫(xiě)I作為前綴,如INeeke,以便直觀的區(qū)分接口和類(lèi)。
7.使用命名空間的層次性結(jié)構(gòu)來(lái)組織各種類(lèi)和接口。
正確:
using Www.Ineeke.Cn; namespace Ineeke.Cn { ... } |
錯(cuò)誤:
using WwwIneekeCn; namespace IneekeCn { ... } |
8.所有代碼必須保證有足夠的注釋?zhuān)⑨屃恳笤?5%以上。需要注釋的內(nèi)容包括以下幾種。
1)關(guān)鍵性語(yǔ)句(如關(guān)鍵的變量聲明,條件判斷等)。
2)類(lèi)名前的文檔注釋?zhuān)ㄒ?/開(kāi)頭的注釋?zhuān)┌?lèi)的簡(jiǎn)單功能說(shuō)明、使用方法等。
3)具有復(fù)雜參數(shù)列表的方法。
9.代碼縮進(jìn)用Tab鍵,不要使用空格鍵。
【編輯推薦】