公司编码规范参考（持续更新）

公司编码规范参考（持续更新）

1.创建类时统一说明模板
设置路径：File->Settings->File And Code Templates

/**
*文件名称(File Name)：$NAME\ast 功能描述(Description)：此模块的功能描述与大概流程说明\ast 数据表(Tables)：本文件中所操作过的数据表\ast 作者(Author)：杰洛.齐贝林\ast 日期(CreateDate)：${DATE}
*修改记录(Revision History)：
*/

2.开发规范说明

1）单行字符数限制不超过 120 个，超出需要换行，增加阅读性 2）类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO。

3）方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式：UserDTO。

4）常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长：MAX_STOCK_COUNT。

5）工具类一律使用hutool封装的，已经基本能满足开发需求，无需开发人员自行再去封装。

6）*类、类属性、类方法的注释必须使用 Javadoc 规范，使用/内容/格式，不得使用 // xxx 方式：
8）代码编写完成后需使用idea自带的代码格式化后才可提交到svn，默认快捷键：Ctrl+Alt+L。（需要下载这个插件）

9）禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
10）在表查询中，一律不要使用 *
作为查询的字段列表，需要哪些字段必须明确写明。 11）sql.xml 配置参数使用：#{}， #param# 不要使用${}
此种方式容易出现 SQL 注入。

3.操作数据库规范
能用java解决的尽量别用sql写

错误示范：
正确示范：

要是查询的数据有多条则可以放在List<你定义的类>中，然后循环插入。要是数据超过1W条，最好分解循环，分段插入。