如下命名規範是在編程中,能夠輔助快速編程的良好方式之一,我一點點的整理出來,以便造成本身的編程規範。還有待完善...編程
0、產品命名規範:spa
結構 | 層次 | 產品 | 模塊 | 功能 | 命名規則 |
UI(界面層) | Web(aspx) | 補習園(BXY) | 前臺模塊(Web) | 會員模塊(Member) | 例如: 會員列表:MemberList.aspx; 會員編輯:MemberEdit.aspx; 會員查看:MemberView.aspx |
UILogicInterface(UI應用接口) | 補習園(BXY) | 前臺模塊(Web) | 會員模塊(Member) | 例如:JHSoft.BXY.Web.UILogicInterface.IMember | |
UILogic(UI接口實現) | 補習園(BXY) | 前臺模塊(Web) | 會員模塊(Member) |
一、解決方案命名:公司簡稱+產品名稱。如ABCSOft.BBS對象
二、解決方案文件夾:以數字排序例如:0.Web表示頁面層;1.IBusinessLogic表示業務邏輯接口;2.BussinessLogic 業務邏輯實現;3.IDataAccess 數據訪問接口;4.DataAccess 數據訪問實現;5.DataEntity 數據實體(能夠包含ORM可持久化對象)排序
三、項目命名:接口
<a>UI邏輯層:ABCSOft.BBS.UILogicInterface接口層、ABCSOft.BBS.UILogic實現層get
<b>服務層:ABCSOft.BBS.DataContracts數據契約、ABCSOft.BBS.ServiceContracts服務契約、ABCSOft.BBS.Hosting宿主層、ABCSOft.BBS.Services服務實現string
<c>業務層:ABCSOft.BBS.BusinessLogic.Member產品
四、文件夾命名:it
五、文件命名:table
<a>UILogic層:
例如:MemberList.cs
<b>服務層:接口=I+模塊名+功能名+Service、實現=模塊名+功能名+Service
例如:MemberInfoService
<c>業務邏輯層:
例如:查詢接口:ISearchInfo、增長、修改、刪除接口:IBasicInfo
六、變量命名:
<a>全局變量,建議使用首字母大寫。如,public string Name;
<b>局部變量,即方法內部變量,建議首字母小寫,後面的單詞首字母大寫。有特殊用途的,能夠前綴釋義。
如,用於返回結果的變量可命名爲rList,r爲前綴,Return的首字母;用於方法參數的變量,能夠聲明以p開頭的pName。
<c>接收的類型後綴,若是是聲明list集合,則以類型後綴。規則爲:前綴+業務+類型
如,var rNameList=new List<String>();
七、屬性命名:Camel命名法
例如:
public String Name
{
get;set;
}
八、方法命名:Camel命名法;查詢列表以Query或者Get開頭,以List或者Detail結束;增長、修改、刪除等方法以業務名開頭,以Add、Update或Save等操做結束;
例如:
public void GetUserList()
{
...
}
public void GetUserList()
{
...
}
public void UserUpdate()
{
...
}
十、控件ID命名:規則(頁面文件名+業務名+控件類型)
例如:MemberList-Name-TextBox