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

前言

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

维护项目的一些方向

项目的底层设计

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

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

文档

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).

引入自动化测试

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

参考

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

                                           

                                           欢迎你们关注个人微信公众号,一块儿学习