项目开发规范文档-->命名规范
| |
返回值枚举类型
位置:放在所在模块ResultEnum文件夹下
命名:Action+ResultEnum
枚举值:
操作成功:Success 操作失败:Failure
……数据异常 DataException
……下架、删除、404 OutData/DeletedData/LostData
……不足、缺乏……等 LackData
未满足…… UnmetData
超出……限制等 BeyondData
调用:
ResultEnum.ActionResultEnum
注释:Data为可替换变量,例如金币不足,可写成LackGold
参数枚举类型
全局枚举类型
| |
查询单一对象方法
服务层(Query)、控制器(Get)下面以服务层为例:
默认命名:QueryDetail
通过邮箱查询会员:QueryDetailByEmail(email作为形参出现)
查询禁用会员:QueryDetailOfDisabled(disabled并未作为形参出现)
查询列表集合方法
服务层(Query)、控制器(Get)下面以服务层为例:
默认命名:QueryList(列表查询)、QueryPageList(分页查询)
一个Service文件中包含两种类型列表,如:礼品兑换Service中包含礼品列表和兑换列表
礼品使用默认命名,兑换列表命名方式:QueryListOfExchangeRecord(列表查询)、QueryPageListOfExchangeRecord(分页查询)
保存数据信息方法
服务层(Save)、控制器(Add、Edit、Save)下面以服务层为例:
默认命名:Save(包含Insert和Update方法)
一个Service文件中包含两种类型列表,如:礼品兑换Service中包含保存礼品和保存兑换记录
礼品使用默认命名,保存兑换记录命名方式:SaveExchangeRecord(Save+对象名称)或者走其他操作数据方法命名方式
删除数据信息方法
服务层(Delete)、控制器(Delete)下面以服务层为例:
默认命名:Delete(删除单一对象)、BatchDelete(批量删除)
一个Service文件中包含两种类型列表,如:礼品兑换Service中包含删除礼品和删除兑换记录
礼品使用默认命名,删除兑换记录命名方式:DeleteExchangeRecord(Delete+对象名称)
其他操作数据方法
动词、动词+名词、动词+形容词+名词等,例如:用户登录(Login)、兑换礼品(ExchageGift)

浙公网安备 33010602011771号