管理系统项目命名规范经验分享
以下为《管理系统项目命名规范经验分享》的无排版文字预览，完整内容请下载
管理系统项目命名及开发规范经验分享
目录
一、必须遵守规则： 2
二、后端命名规范 2
三、注释 3
四、SQL语句 4
一、必须遵守规则：
1、【强制】一切命名不得使用拼音。为了方便互相理解一切命名单词使用百度翻译或谷歌翻译通过中文翻译成英文模式的英文结果进行命名。
2、【强制】一切命名不得使用模糊、随意、无意义的命名：例如abc、a1和haha等等。
3、【参考】命名类名时不要与已存在的类名相同，比如A模块控制层命名为UploadController，你不可命名相同的名称，你可以用模块名简写加上UploadController，例如原料库的上传可以写原料单词前三个首字母做模块简写当成前缀，这样的话就是MatUploadController。
4、【强制】必须写注释，自己开发的功能模块注释覆盖率要超过75%，如果业务非常复杂，注释率要达到90%。同时注释描述清晰，必须注释的文件有，“.java”、“.xml”、“.js”、”.css”和“.html”文件等。
5、【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。 反例：_name / __name / $name / name_ / name$ / name__ 。
二、后端命名规范
1、由于Java面向对象编程的特性, 在命名时应尽量选择名词。
2、驼峰命名法（Camel-Case）: 当变量名或函式名是由一个或多个单字连结在一起，而构成的唯一识别字时，首字母以小写开头，每个单词首字母大写（第一个单词除外）。
3、控制层（类）：
功能单词前三个首字母或有代表性的三个字母+子功能模块+Controller。
4、业务逻辑层（类）：
功能单词前三个首字母或有代表性的三个字母+子功能模块+Service。
5、数据持久层（类/ interface）：
a、功能单词前三个首字母或有代表性的三个字母+子功能模块+Dao。
b、MyBatis映射文件名必须与interface名相同。
模型类：a、功能单词前三个首字母或有代表性的三个字母+子功能模块+Model。
b、类名首字母必须大写，类中的属性字段至少是2个字母的全小写的单词。
6、静态工具类：类名首字母必须大写，方法必须首字母大写。
7、接口（interface）：类名首字母必须大写，方法必须首字母大写，驼峰方式。
8、类名首字母大写，驼峰方式。
9、变量名首字母小写，驼峰方式。
10、常量所有字母必须大写。
11、各功库功能模块单词简写：
a、material(mat 原料库
b、purchase(pur 外购库
c、half(hal 成品库
d、device(dev 设备库
e、buy(buy 采购管理
f、common(com 通用
g、system(sys 系统
12、命名关键词：
插入单条数据：insert
插入多条数据：add
删除单表数据：del
删除多表数据：remove
查询数据：find
依赖条件：By,例如按照主键查询原料库存findMatInventoryById或者findMatInventoryByPrimarykey，通常使用的是ById。同样更和.新删除也可以这样写。
更新单表数据：update
更新多表数据：edit
List或list：列表变量后缀，例如原料库存列表 matInventoryList
13、所有操作数据库的语句都要写异常处理：如果触发异常、把修改过的数据改回来，保持数据一致性。
14、所有操作都 内容过长，仅展示头部和尾部部分文字预览，全文请查看图片预览。 开发手册
说明：
SELECT LENGTH("轻松工作")； 返回为 12
SELECT CHARACTER_LENGTH("轻松工作")； 返回为4
如果需要存储表情，那么选择utf8mb4 来进行存储，注意它与 utf-8 编码的区别。
11. 【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。 说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。
[文章尾部最后300字内容到此结束,中间部分内容请查看底下的图片预览]请点击下方选择您需要的文档下载。
- 四年级古诗文
- C语言个人学习笔记
- 10古诗词句注释
- 论语十二章原文、注释、翻译
- 2.4.古诗三首（第1课时）教案
- 中文大写金额数字
- BIM竞赛模型建模标准及命名标准
- 英文书写知识
- 建行收入证明
- 11.收入证明
- 寒假社会实践注意事项及材料上交要求
- 课题报告的格式示范
- 一天一篇小古文2-1
- 三年级古诗文
- ***论文作业格式要求（统一封面、统一字体、统一注释)
以上为《管理系统项目命名规范经验分享》的无排版文字预览，完整内容请下载
管理系统项目命名规范经验分享由用户“烂人65”分享发布，转载请注明出处