1.用Pascal規(guī)則來(lái)命名方法和類(lèi)型。
public class DataGrid
{
public void DataBind()
{
}
}
2.用Camel規(guī)則來(lái)命名局部變量和方法的參數(shù).
public class Product
{
private string _productId;
private string _productName;
public void AddProduct(string productId,string productName)
{
}
}
3.所有的成員變量前加前綴“_”。
public class DataBase
{
private string _connectionString;
}
4.接口的名稱(chēng)加前綴 “I”。
public interface IConvertible
{
byte ToByte();
}
5.自定義的屬性以“Attribute”結(jié)尾。
public class TableAttribute:Attribute
{
}
6.自定義的異常以Exception結(jié)尾。
public class NullEmptyException:Exception
{
}
7.方法的命名。一般將其命名為動(dòng)賓短語(yǔ)。
public class File
{
public void CreateFile(string filePath)
{
}
public void GetPath(string path)
{
}
}
8．局部變量的名稱(chēng)要有意義。
不要用x，y，z等等，用For循環(huán)變量中可使用i, j, k, l, m, n。
public class User
{
public void GetUser()
{
string[] userIds={"ziv","zorywa","zlh"};
for(int i=0,k=userIds.Length;i<k;i++)
{
}
}
}
9．所有的成員變量聲明在類(lèi)的頂端，用一個(gè)換行把它和方法分開(kāi)。
public class Product
{
private string _productId;
private string _productName;
public void AddProduct(string productId,string productName)
{
}
}
10．用有意義的名字命名namespace，如：公司名、產(chǎn)品名。
namespace Zivsoft//公司命名
{
}
namespace ERP//產(chǎn)品命名
{
}
11．建議局部變量在最接近使用它時(shí)再聲明。
12．使用某個(gè)控件的值時(shí)，盡量命名局部變量。
public string GetTitle()
{
string title=lbl_Title.Text;
return title;
}
14.把引用的系統(tǒng)的namespace和自定義或第三方的用一個(gè)換行把它們分開(kāi)。
using System;
using System.Web.UI;
using System.Windows.Forms;
using CSharpCode;
using CSharpCode.Style;
15.文件名要能反應(yīng)類(lèi)的內(nèi)容，最好是和類(lèi)同名，一個(gè)文件中一個(gè)類(lèi)或一組關(guān)連類(lèi)。
16.目錄結(jié)構(gòu)中要反應(yīng)出namespace的層次。
17.大括號(hào)"{"要新起一行。
public Sample()
{
//
// TODO: 在此處添加構(gòu)造函數(shù)邏輯
//
}
我自己總結(jié)的一套命名規(guī)則，其實(shí)規(guī)則很重要，它是一種標(biāo)準(zhǔn)，可有可無(wú)，但有總會(huì)比無(wú)好，大家正在編碼的同志仔細(xì)看看，給點(diǎn)改進(jìn)意見(jiàn)。