【如何提升代码工程质量】code review篇

server/2024/12/2 5:34:36/

应该对于基本上所有软件相关的公司来说,都有committer机制,即代码写好之后会提交合并请求,待相关人员code review通过后再进行合入,所以code review就是代码合入代码仓库的最后一道关卡,对于代码质量的影响也是不容忽视的,那么作为在华为、阿里等大厂担任过committer的老code reviewer,我在code review关注哪几方面的东西呢:

  • 代码风格

比如命名是否正确、函数抽象是否合理等,这些影响代码后面的可读性。在我刚从学校毕业的第一份工作的第一个项目中,那时候还保持着在学校里面的思维,就是代码只要实现功能就行,所以命名各种a、b、c、test之类的,函数抽象也不注意,这样当然不会影响功能的实现,但问题是,商业产品的代码是有一个漫长的维护周期的,当你实现的功能不可避免的出现问题的时候,麻烦就来了。当时我第一个项目交付之后半个月,就遇到了一些功能上的问题,需要我去改下代码,这个时候我去读我半个月前写的代码,已经完全读不懂了,看到那些a、b、c、test的变量名,完全不知道这个当时是想拿来存什么的;好不容易看懂一点,需要改的时候,因为函数也没有很好的规划,导致一个功能点需要霰弹式的修改很多地方,维护起来异常困难。从那次经历以后,我就知道软件工程远远不是实现功能这么简单,可读性、可维护性也会是其中的重要一环。

  • 是否有逻辑问题,比如无法退出的for循环之类的

这种最好也能在code review这一环节就被检查出来,方法也非常简单,看到任何循环语句,比如for、when、while的时候多留一个心眼,看一下循环条件判断语句有没有恒为true的情况,特别是那种不在循环条件里面写循环条件(设置循环条件为true),而是在循环体里面去设置不满足条件时再break的情况,这种要特别留心看下有没有可能无法跳出循环。

  • 是否有资源泄漏的风险

这个比较难一点,需要对当前所使用的技术栈有可能造成内存泄漏的方式有所了解,比如C++有没有锁申请了没释放、有没有从堆上申请了内存没有释放;golang有没有把切片的一部分作为一个切片返回出去,比如把一个长度为1000的切片的前10个数据作为一个切片返回出去,比如a[:10]。

  • 流程完善

除了人通过肉眼code review外,还可以增加各种辅助检查工具,比如一些静态检查的lint,或者提交以后自动跑一次编译,避免合入以后引入编译问题。

  • speed and performance

当前代码构造的方法是否足够合理,是否是性能最好的方法,可以通过大O表示法来进行一个大体的判断,同时也可以判断一下圈复杂度是否过高。

  • 是否重复造轮子

这个要分成两部分来说。一是对于已经有的轮子,就不要重复去造一个了;另外就是如果提交的代码里面多次出现一段代码,考虑把它造成一个轮子,也就是抽象成一个函数,而不是在多个地方把它写多次。

  • 可靠性(容错性)

如果发生错误的话,这个地方是否会崩溃?是否能比较好的抛出有意义的异常?

  • 是否有冲日志的可能

是否会大量打无意义的日志,导致日志被冲掉,影响正常定位问题。

  • 是否有错误被抑制了

这个是最微小、最容易被忽视、却又影响很明显的一点。错误被抑制是我自己定义出来的一个术语,大意是说错误没有正确的被展示。具体内容可以关注我的另外一篇文章:使用golang的AST编写定制化lint_golang lint-CSDN博客

最后,祝大家提升代码工程质量之后能早点下班,不用加班来填质量的坑~


http://www.ppmy.cn/server/146623.html

相关文章

CSS 背景、阴影和混合模式

网站的好坏在于细节,在实现页面里某个组件的布局并写完样式之后,不要急着继续,有意识地训练自己,以挑剔的眼光审视刚刚完成的代码。 1 背景与渐变 background-image 指定文件或者生成的颜色渐变为背景图片。 background-origin…

【面试题】2025年百度校招Java后端面试题

文章目录 前言一、网络IO1、服务器处理并发请求有哪几种方式?2、说一下select,poll,epoll的区别?3、Java 有一种现代的处理方式,属于异步I/O,是什么?redis,nginx,netty 是…

Qt—QLabel 使用总结

参考链接:Qt—QLabel 使用总结 一、简述 QLabel(标签控件) 提供了一个文本或图像的显示,没有提供用户交互功能。 一个 QLabel 可以包含以下任意内容类型: -纯文本:使用 setText() 设置一个 QString 富文本:使用 setText() 设置一个富文本的 QString图像:使用 setPixma…

探索光耦:晶体管光耦——提升稳定性与安全性,推动能源效率革命

随着电子技术的飞速发展,开关电源(Switching Power Supply, SPS)已成为现代电子设备中不可或缺的核心组件。它广泛应用于计算机、通信设备、家电、电动工具等各种领域。开关电源因其高效率、体积小、重量轻而受到青睐。然而,由于开…

Cobalt Strike 4.8 用户指南-第十一节 C2扩展

11.1、概述 Beacon 的 HTTP 指标由 Malleable Command and Control (Malleable C2) 配置文件控制。Malleable C2 配置文件是一个简单的程序,它指定如何转换数据并将其存储在事务中。转换和存储数据的同一程序(向后解释&#xff0…

【Vue3】main.js

【Vue3】main.js 创建Vue应用实例引入并配置路由配置状态管理挂载应用全局属性与方法使用其他插件 在Vue 3项目中,main.js 文件是整个应用的入口点。 它负责初始化Vue实例、配置全局选项、注册全局组件、引入插件以及挂载Vue实例到DOM上。 通过 main.js,…

详解八大排序(一)------(插入排序,选择排序,冒泡排序,希尔排序)

文章目录 前言1.插入排序(InsertSort)1.1 核心思路1.2 实现代码 2.选择排序(SelectSort)2.1 核心思路2.2 实现代码 3.冒泡排序(BubbleSort)3.1 核心思路3.2 实现代码 4.希尔排序(ShellSort&…

【Vue3】App.vue

【Vue3】App.vue App.vue 是 Vue 3 项目中的一个核心文件,它作为整个应用的入口组件,是所有其他页面和组件的基础。 在 Vue 项目中,App.vue 文件起到了非常关键的作用,它负责组织和渲染整个应用程序的结构。 下面我们来深入解读 A…