工程效率篇-如何更好地维护项目

前言

项目的初期有可能为了尽快的落地实现功能,对项目中一些边界的约束并没有很好的考量.随着项目代码量的增长,代码的质量是决定一个项目是否能长期良好发展的关键因素.项目的维护更像是短期时间与未来时间权衡的过程.下面是自己对如何更好的维护代码的一些思考.

维护项目的一些方向

项目的底层设计

项目的功能越来越庞大的时候,需要更多的功能模块来支持业务模块的运行.应该尽早的建立功能模块的隔离和分层,能有效的防止功能模块的耦合从而提高系统的可维护性.
通过将相同的功能进行提取

对不同的模块进行隔离,单独维护

文档

1. 梳理项目中关键技术的文档,quick Start等,有利于团队的新人快速的接入项目进行开发.
2. 通用的api,工具等可以通过jsDoc等工具生成阅读性强的文档.
3. 在进入开发前思考相应的实现并且通过文档的方式呈现.

提高可读性

在提高可读性上并没有一个完全的最佳实践.需要尽快的找到适合整个团队的方案.提高可读性可以有以下的几个方向:

1. 尽早的建立编程规范并且通过工具去约束编程规范,例如VS Code生成代码片段、eslint、husky、commitizen等.
   husky可以在特定的git hooks执行用户指定的行为.
   
   commitizen可以辅助生成规范化的git commit.
   
2. review机制
   长期有效的review机制能有效的减少团队出现case的概率并且有利于团队形成统一的代码风格和吸收优秀的案例.

减少重复工作

1. 思考如何写的更少.同样模式的代码是否可以进行抽象来进行整合.
2. 模块的提取(组件, utils).

引入自动化测试

在关键路径上引入自动化的测试流程.

参考

代码质量与规范，那些年你欠下的技术债
好的提高代码质量的方法有哪些