举例讲解代码规范
例如:表名 :jeecg_sys_demo
第一部分:代码文件命名规则如下:
首先:表名采用驼峰写法转换为Java代码使用单词 jeecg_sys_demo => JeecgSysDemo
[1].control命名 :JeecgSysDemoControl
[2].Servlice命名:JeecgSysDemoServiceI/JeecgSysDemoServiceImpl
[3].JSP命名 :jeecg-sys-demo.jsp(表单页面)
jeecg-sys-demo-list.jsp(列表页面)
jeecg-sys-demo-*.jsp(新增表单页面 例如:detail)
[4].control中方法命名:
页面触发业务方法以do*开头
页面跳转方法以go*开头
(方法标签注释需和方法名保持一致)
第二部分:代码注释规范
[1].代码存在缺陷或者留有功能点的代码,采用以下方式进行标示
//TODO author:zhangdaihao for:插入未完成 date:20130711
[2].系统已有代码的修改采用以下注释
//----------------------------------------------------------------
//update-begin--Author:zhangdaihao Date:20130205 for:[bugfree号]树机构调整
//update-end--Author:zhangdaihao Date:20130205 for:[bugfree号]树机构调整
//----------------------------------------------------------------
[3].业务逻辑注释
a.方法注释 参入传出参数注释说明