Skip to content

💻 代码规范

  • 代码简洁规范,结构合理清晰,前后端遵循编码规约实现代码规范。
  • 后端遵循《阿里巴巴 Java 开发手册》,通过 P3C-CodeStylemaven-checkstyle-plugin 规范代码。
  • 前端 通过 代码风格检查(Code Linting,简称 Lint)保障代码规范一致性。

代码规范收益

遵循相应的代码规范有以下好处:

  • 较少 bug 错误率
  • 高效的开发效率
  • 更高的可读性

后端 代码规范工具

  • maven-checkstyle-plugin(Maven 插件之代码检查)

    • 描述:用于检测代码中不符合规范的地方。
  • CheckStyle-IDEA

    • 描述:自动检查 Java 代码规范
  • Alibaba Java Coding Guidelines(P3C 插件)

    • 描述:代码规范检查插件
  • SonarLint

    • 描述:帮助你发现和修复代码的错误和漏洞
  • MybatisX

    • 描述:MyBatis 增强插件,支持自动生成 entity、mapper、service 等常用操作的代码,优化体验

前端 代码规范及校验工具

  • ESLint 用于 JavaScript 代码检查
  • Stylelint 用于 CSS 样式检查
  • Prettier 用于代码格式化
  • Commitlint 用于检查 git 提交信息的规范
  • Publint 用于检查 npm 包的规范
  • Cspell 用于检查拼写错误
  • lefthook 用于管理 Git hooks,在提交前自动运行代码校验和格式化