返回介绍

345.代码规范

发布于 2020-09-14 22:20:45 字数 2880 浏览 1246 评论 0 收藏 0

  • 1、TODO 随时记以免忘(有道云)

  • 2、建表规范

jeecg-boot-module-system/docs/规范/设计样板/JEECG-开发说明书-XX模块-建表规范v1.0.xlsx
  • 3、SVN代码提交和修改规范
jeecg-boot-module-system/docs/规范/编码必看规范
  • 4、代码注释规范
类注释、方法注释 、实体字段注释
参考: https://my.oschina.net/jeecg/blog/3198358
  • 5、代码格式化说明
新增代码必须格式化,老代码禁止格式化
  • 6、代码规范扫描
1、不允许代码里面写变量值,需要使用常量定义(统一变量文件或者一个模块一个常量文件)
2、复杂代码逻辑,要增加步骤说明

代码扫描检查插件安装: pc3
jeecg-boot-module-system/docs/规范/阿里巴巴Java开发手册(详尽版).pdf
https://www.cnblogs.com/han-1034683568/p/7682594.html

阿里巴巴Java开发手册 下载

  • 7、TODO 规范,记录缺陷点(及时纠正)

    代码有缺陷或者未完善的地方,加TODO标记(前端、后端都适用)
    
  • 8、开源issue处理

    回复issue具体修复问题方法 或 回复下个版本修复
    

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文