dbsd_kczx_java/jeecg-boot/jeecg-boot-module-system/docs/规范/编码必看规范

24 lines
1.3 KiB
Plaintext
Raw Normal View History

2019-07-05 15:38:38 +08:00
【第一部分】代码注释规范
[1].代码修改注释
//update-begin--Author:zhangdaihao Date:20140212 for[bugfree号]树机构调整--------------------
//update-end--Author:zhangdaihao Date:20140212 for[bugfree号]树机构调整----------------------
[2].代码存在缺陷或者留有功能点的代码,采用以下方式进行标示
//TODO authorzhangdaihao for:插入未完成 date:20130711
[3].SVN提交注释
[author:用户名 date:20130203 for(bugfree号码)增加查询条件,组织机构]
【第二部分】修改文件记录
代码修改日志 /jeecg-boot/docs/代码修改日志
数据库修改日志:/jeecg-boot/docs/DB修改日志.sql
【第三部分】建表规范
1.主键必须是ID,字符串类型32位长度唯一索引;
2.建表标准字段,必须有:创建人、创建时间、修改人、修改时间等标准字段;
3.表字段注释,每个字段必须设置注释说明;
4.表字段注释状态类型的字段必须说明取值规则比如性别sex取值规则
比如:'性别 0/男,1/女'
5.索引,查询频率高的字段加索引(单字段索引 、组合索引);
6.类型字段尽量用字符串varchar类型1-2长度少用int类型避免不必要的问题。