2023一组技术提升计划

2023年整体技术方面聚焦在代码规范和代码质量上面，希望能够通过推动代码规范的执行和代码质量的审核来提升软件品质。

规范

  • 代码规范：统一代码规范，使用阿里巴巴代码规范，IDEA安装阿里巴巴规范插件。

    • 代码规范中强制要求的必须执行，其它项按自己的风格使用。
    • 旧代码不做要求，新代码强制执行。
    • 二季度结束后和年度结束后，随机抽查新代码，形成考核结果。

  • 文档规范：中大型项目需要有开发文档，就写在README中，讲述开发逻辑和开发中不为人知的秘密

    • 文档书写使用Markdown语法，每个项目的README中都有语法链接
    • 文档中包含但不限于需求描述，实现方案，升级记录，注意事项等。
    • 旧代码不做要求，新代码强制执行。
    • 二季度结束后和年度结束后，随机抽查新代码，形成考核结果。
    • 开发文档模板会在年前提供出来。

为什么要进行代码规范和文档规范

  1. 目前代码中，因个人风格的不通，代码风格差异也比较大，在维护代码的时候要去不停的适应不同人的代码风格，因此规范代码风格，减少维护适应代码时间。
  2. 目前代码中，因为没有好的规范，所以部分地方还是存在风险，通过实行好的代码规范来避免风险产生问题。
  3. 目前代码中，因为没有文档，所以每次看代码遇到不懂的地方需要去猜，可能存在误差。

质量

  • 代码审核：周六分享会开发人员把自己上周的开发工作说一遍，视开发内容决定是否需要代码审核
    • 如果需要代码审核，必须要有开发文档，让组员能够理解在干什么
    • 使用代码IDEA插件搭配Upsource快速审核,https://www.jianshu.com/p/fab6539a6749
    • 写代码的人讲解自己的代码，阐述清楚为什么这么写
    • 鼓励自己提交代码审核，量化代码审核次数

内容输出

  • 完善一组wiki，问题和开发技术输出，
  • 周六分享会后技术分享同样提交wiki
  • 周六分享会后技术分享完毕后如果有想分享的东西同样可以分享