MISBoot低代码开发平台

编码规范

一、 类命名

每个单词的首字母大写,如UserService,UserController

二、 方法/函数命名

采用驼峰命名法,如getUserList,getUserDetail

控制器中公用方法命名规范:

1) 渲染页面

模块首页:index()

新增页面:add()

编辑页面:edit()

2) 分页集数据接口

获得分页集:getPageSet()

3) 列表数据接口

获取列表:getList(int page, int size)

4) 详情数据接口

根据主键获得详情:getDetail(String uuid)

5) 保存/更新数据接口

保存数据:save(Entity entity)

更新数据:update(Entity entity)

6) 删除数据接口

根据主键删除数据:delete(String uuid)

7) 移除数据接口

根据主键移除数据:remove(String uuid)

8) 导出数据接口

导出Excel:exportExcel(HttpServletResponse response)

三、 变量命名

采用驼峰命名法,标识码字段后面加Id,如userName表示用户姓名,userNameId表示用户标识码(员工号)

四、 常量命名

全部采用大写字母,多个单词之间用连接,如FRAMEVERSION

五、 其它

以下描述中:Xxxx代表系统名,Yyyy代表模块名,Zzzz代表方法名,注意X、Y、Z大小写

文档更新时间: 2019-11-20 12:40 作者:佐佑时代