乐趣区

关于前端:提升代码质量完整的代码审查清单攻略

jiezi

本文首发于微信公众号：大迁世界, 我的微信：qq449245884，我会第一工夫和你分享前端行业趋势，学习路径等等。
更多开源作品请看 GitHub https://github.com/qq449245884/xiaozhi，蕴含一线大厂面试残缺考点、材料以及我的系列文章。

快来收费体验 ChatGpt plus 版本的，咱们出的钱
体验地址:https://chat.waixingyun.cn
能够退出网站底部技术群，一起找 bug.

本文次要介绍了代码审查清单。代码审查是软件开发中的关键环节，它有助于保障代码品质，进步团队合作效率。文章强调了代码审查的重要性，并提供了具体的代码审查清单，以帮忙开发人员在我的项目开发过程中遵循最佳实际。

文章将代码审查清单分为以下几个局部：个别准则、设计、性能、复杂性、测试和其余。每个局部都提供了具体的检查点和注意事项。个别准则包含代码格调、可读性、可维护性等方面；设计方面关注架构、模块化、可扩展性等；性能局部涵盖需要实现、错误处理、性能优化等；复杂性局部次要关注代码的逻辑复杂度，提倡简洁易懂的编程；测试局部强调自动化测试的重要性，要求开发人员确保代码覆盖率；其余方面包含正文、文档等辅助性内容。

作者还揭示开发人员在进行代码审查时，要有急躁，放弃凋谢的心态，以进步代码品质为指标，防止个人观点和爱好烦扰。总之，这篇文章为软件开发团队提供了实用的代码审查清单，帮忙开发人员在我的项目开发过程中遵循最佳实际，确保代码品质和团队合作效率。

上面是注释~

领有一个清单是开发团队的重要组成部分。它将帮忙咱们简化代码审查并帮忙咱们专一于咱们的优先事项。

这些是我在审查新代码或拉取申请时思考的事项。

1. 可读性

代码的可读性在行业中被高度低估。大多数人推崇代码文档和内联正文，这的确是好的。然而可读性强的代码对于保护牢靠和可扩大的代码库来说更好。

这些是我在查看代码可读性时思考的关键因素。

代码缩进

只管谬误的代码缩进不会影响程序的性能，但它的确会影响浏览和保护代码的人。即便对于专家来说，如果没有适当地缩进，也很难辨认函数、循环和条件的边界。

适当的缩进是咱们能够做的第一件事，以确保咱们的代码对相干方可读且清晰。

命名约定

咱们命名函数和变量的形式具备深远的影响。咱们为函数、变量和类抉择的名称应该是自阐明的。在某些状况下，自阐明的名称会太长，在这种状况下，咱们能够应用缩写。

为了获取用户列表，咱们能够命名函数为 getUsers() 或 getUserList()，这比随机命名如 getData 或一些无意义的名称要好得多。同样，上述函数的响应能够调配给可读变量，如 userList 或 users，这比风行的 "newArray" 要好得多。

有很多可用的缩进格调，其中驰名的有 K&R 格调、OTBS、1TBS、Stroustrup 和 Allman 格调。

代码正文

有一句风行的说法：

“代码是给编译器的，而正文是给程序员的。”咱们不能总是让咱们的代码库自我解释。当代码无奈自我解释时，正文就会呈现。我集体只喜爱在代码不够自我解释时编写代码正文。

2. 性能

看到代码时，总是要寻找更简略的解决方案，即便在代码库中少一次迭代，当你看到更大的画面时，代码的体现也会更好。基本上，咱们须要查看代码是否运行工夫过长，是否有任何更简略的解决方案值得施行。

在绩效畛域中，应思考的关键因素：

  • 性能要求，是否有性能 SLA 作为要求的一部分

  • 查看内部调用，服务外的调用老本昂扬

    • 数据库调用
    • 不必要的网络调用
  • 寻找可能的内存透露
  • 确保代码在不须要时敞开连贯和流
  • 查看可能的竞态条件

3. 可重用性

代码重用是应用现有代码来实现新性能和性能的办法。DRY 准则，“不要反复本人”有助于缩小代码反复。该准则很简略，如果须要执行某个操作超过一次，请将该代码移动到函数中并重用它。这种代码形象有助于函数使代码可重用和可扩大。这也有助于调试，因为咱们不用在两个中央修复谬误。

4. 可维护性

遵循最佳实际是放弃高可维护性的要害。代码库应该涣散耦合且高度内聚。这两个术语看起来可能互相矛盾，但它们独特作用能够创立高度可保护和可扩大的应用程序。

代码应该以这样的形式实现，即无关的单元之间涣散耦合，相干单元之间应该具备高内聚性。如果咱们不遵循这个最佳实际，咱们将朝着高耦合和低内聚的方向后退，这将导致过多的依赖性和减少的破绽危险，因为一个单元中的谬误将影响所有依赖的单元。遵循 SOLID 准则将有助于实现这个良好的实际。

SOLID 准则实际上是 5 个设计准则的联合：

  1. 繁多职责准则
  2. 开闭准则
  3. 里氏替换准则
  4. 接口隔离准则
  5. 依赖倒置准则

5. 单元测试

审查测试覆盖率并找出那些须要解决的边缘状况可能会很辣手且耗时，但这是值得的。我不想解释单元测试如何有助于保护代码品质。这些益处家喻户晓，但人们依然往往漠视它。

遵循 TDD 是使单元测试成为必须的好办法。

原文：https://vinuvasudev.medium.com/code-review-checklist-bab2bd65…

代码部署后可能存在的 BUG 没法实时晓得，预先为了解决这些 BUG，花了大量的工夫进行 log 调试，这边顺便给大家举荐一个好用的 BUG 监控工具 Fundebug。

交换

有幻想，有干货，微信搜寻 【大迁世界】 关注这个在凌晨还在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收录，有一线大厂面试残缺考点、材料以及我的系列文章。

退出移动版