asp.net命名规范
以下命名规范是在编程中,可以辅助快速编程的良好方式之一,我一点点的整理出来,以便形成自己的编程规范。还有待完善...
0、产品命名规范:
结构 | 层次 | 产品 | 模块 | 功能 | 命名规则 |
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) |
1、解决方案命名:公司简称+产品名称。如ABCSOft.BBS
2、解决方案文件夹:以数字排序例如:0.Web表示页面层;1.IBusinessLogic表示业务逻辑接口;2.BussinessLogic 业务逻辑实现;3.IDataAccess 数据访问接口;4.DataAccess 数据访问实现;5.DataEntity 数据实体(可以包含ORM可持久化对象)
3、项目命名:
<a>UI逻辑层:ABCSOft.BBS.UILogicInterface接口层、ABCSOft.BBS.UILogic实现层
<b>服务层:ABCSOft.BBS.DataContracts数据契约、ABCSOft.BBS.ServiceContracts服务契约、ABCSOft.BBS.Hosting宿主层、ABCSOft.BBS.Services服务实现
<c>业务层:ABCSOft.BBS.BusinessLogic.Member
4、文件夹命名:
5、文件命名:
<a>UILogic层:
例如:MemberList.cs
<b>服务层:接口=I+模块名+功能名+Service、实现=模块名+功能名+Service
例如:MemberInfoService
<c>业务逻辑层:
例如:查询接口:ISearchInfo、增加、修改、删除接口:IBasicInfo
6、变量命名:
<a>全局变量,建议使用首字母大写。如,public string Name;
<b>局部变量,即方法内部变量,建议首字母小写,后面的单词首字母大写。有特殊用途的,可以前缀释义。
如,用于返回结果的变量可命名为rList,r为前缀,Return的首字母;用于方法参数的变量,可以声明以p开头的pName。
<c>接收的类型后缀,如果是声明list集合,则以类型后缀。规则为:前缀+业务+类型
如,var rNameList=new List<String>();
7、属性命名:Camel命名法
例如:
public String Name
{
get;set;
}
8、方法命名:Camel命名法;查询列表以Query或者Get开头,以List或者Detail结束;增加、修改、删除等方法以业务名开头,以Add、Update或Save等操作结束;
例如:
public void GetUserList()
{
...
}
public void GetUserList()
{
...
}
public void UserUpdate()
{
...
}
10、控件ID命名:规则(页面文件名+业务名+控件类型)
例如:MemberList-Name-TextBox