Hawthorn-Api

# 规范说明

  1. 减少bug处理
  2. 有助于代码审查
  3. 降低维护成本

# 规范要求

# 1. 统一类注释、方法注释

    选择: File→Settings→Editor→Live Templates。
    点击: 右边的加号,选择Template Group,创建一个分组
    点击: 模板页面最下方的警告define，来设置将模板应用于哪些场景，选择Everywhere-->Java即可
    类注释模板:
                        *
                * @Copyright: Copyright (c) $year$ qinp
                * @remark: TODO
                * @author:qinp
                * @date:$DATE$ $TIME$
                * @version v1.0.1
                */
    方法注释模板:
                  *
                * @remark:
                $params$
                    $return$
                * @author: qinp
                    * @date: $date$ $time$
                * @version: 1.0.1
                    * Modification History:
                * Date       Author       Version          Description
                * -----------------------------------------------------------
                      * $date$  qinp         v1.0.1            init
                      */
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 2. 包名称采用小写命名，类名称采用首字母大写并且以驼峰方式命名

    例：包名user 类名userMng
1

# 3. Provider类中不能使用select * 或 selectone 的SQL写法

    例：select * from table
1

# 4. SQL语句不能没有格式化直接写到Provider里，要格式清晰宜读，特别是复杂的SQL

    例：
        select 
          user_id,
          user_name 
        from table 
        where 1=1
1
2
3
4
5
6

# 5. 涉及字典翻译字段，不能在SQL语句中进行查询翻译

    例：transHash.put("city", "division");
1

# 6. SQL要求原字段必须小写，带下划线"_"的字段一定要用"AS"去转驼峰

    例：select user_id as userId，user_name as userName from table
1

← 数据库 →