哪些代码是 Code Review 中的大忌?—— 以 Python 为例

请添加图片描述

Code Review 首要达成的结果是更好的可读性

在此基础上才是进一步发现项目的 Bug、处理性能优化上的问题。

因为,编码是给人看的,不是给计算机(Coding for human, NOT computer)。

一. 滥用缩写命名 Overusing abbreviation

大部分业务,尤其是不是直接暴露在前端的业务,不需要考虑混淆的设计,别因为少打两个字,让你的同伴都搞混了!

# Bad. 自成体系的缩写
lst = [1, 2, 3, 4, 5]
sqrd_lst = [num**2 for num in lst]
fltd_sqrd_lst = list(filter(lambda x: x % 2 == 0, sqrd_lst))
# Good. 一眼看出变量名的含义
riginal_numbers = [1, 2, 3, 4, 5]
squared_numbers = [num**2 for num in original_numbers]
filtered_squares = list(filter(lambda x: x % 2 == 0, squared_numbers))

二. 语法糖可能是毒药 Syntax Sugar can be Poison

语法糖是常见的程序员炫技手段,但即使对写下这段代码的人,经过一段时间后,也未必能在第一时间读出这段代码的含义。

例如在 Python 中:

  1. 使用布尔操作符作为条件判断
    第一段炫技代码,不熟悉的同学可能第一反应是 result=True
# 炫技,可读性差
is_valid = True
result = is_valid and "Valid" or "Invalid"# 等价,可读性更好
result = "Valid" if is_valid else "Invalid"
  1. 使用列表推导式处理嵌套列表
matrix = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
flattened = [num for row in matrix for num in row]
  1. 过度追求“简洁”的 lambda 表达式
    lambda 表达式用在 sorted 中做为排序参数是比较常用的,但过度追求单行表达,是不可取的,除了可读性差,还违背了程序设计的单一职责原则

单行、可读性差版本:

students = [{"name": "Alice", "age": 25, "grade": 90},{"name": "Bob", "age": 22, "grade": 85},{"name": "Charlie", "age": 28, "grade": 88}
]sorted_students = sorted(students, key=lambda x: (lambda y: (lambda z: z["grade"] - y["age"])(y))(x))

分离职责,可读性好版本:

def calculate_score(student):return student["grade"] - student["age"]sorted_students = sorted(students, key=calculate_score)

当然,语法糖也有少部分是增加可读性的,可以作为代码规范使用:

big_number = 1_000_000_000
# equivalent to big_number = 10000000001 < x < 10
# equivalent to 1 < x and x < 10

三. 不可预测的代码 Unpredictable Code

好代码是可预测的,坏代码是给人惊吓的。

一种是由于开发人员基础不扎实无意识造成的:
例如:
使用可变变量作为参数

# WRONG:
def add_numbers(a, b, result=[]):result.append(a + b)return result# Example usage
print(add_numbers(1, 2))   # Output: [3]
print(add_numbers(3, 4))   # Output: [3, 7]
print(add_numbers(5, 6))   # Output: [3, 7, 11]# CORRECT:
def add_numbers(a, b, result=None):if result is None:result = []result.append(a + b)return result# Example usage
print(add_numbers(1, 2))   # Output: [3]
print(add_numbers(3, 4))   # Output: [7]
print(add_numbers(5, 6))   # Output: [11]

另一种,是开发设计的偷懒、或者未进行事先沟通自作主张。

最常见的是更改接口参数类型,返回不符合预期的结构数据。比如不允许为空的字段返回了空,API 版本没有变化的情况下,增加了必传的参数等等

再如,状态码与实际的情况不符合。

虽然开发人员处理了几种已知的错误,但是状态码一直是 200,对于调用方,如果使用 status.OK 则永远返回 True,处理不到这些异常情况。

from flask import Flask, jsonify
app = Flask(__name__)@app.route('/delete-file/<file_id>', methods=['DELETE'])
def delete_file(file_id):try:# Delete the file# ...return jsonify({"status": "success"})except FileNotFoundError:return jsonify({"status": "error", "message": "File not found"})except PermissionError:return jsonify({"status": "error", "message": "Permission error"})if __name__ == '__main__':app.run()

正确的写法,应该使用对应的状态码,确保其他框架可以信任这个结果:

# Following the Principle of Least Astonishment in error handling
from flask import Flask, jsonify
from werkzeug.exceptions import NotFound, Forbiddenapp = Flask(__name__)@app.route('/delete-file/<file_id>', methods=['DELETE'])
def delete_file(file_id):try:# Delete the file# ...return jsonify({"status": "success"})except FileNotFoundError:raise NotFound(description="File not found")except PermissionError:raise Forbidden(description="Permission error")if __name__ == '__main__':app.run()

Bonus: 有没有可以抄的解决方法?

  1. 参考大厂的代码风格规范

Google 开放了不少常见语言的代码规范:
https://google.github.io/styleguide/

请添加图片描述

小米也有数据库设计,SQL 相关的规范:
https://github.com/XiaoMi/soar

如果接手一个新的语言或工具,还可以在搜索资料时加一个 best pratice 看看其他人的经验。

  1. 借助插件或 CI 工具

对于常见的规范单行代码长度、空格等,可以使用 ESLint、Pylint,、 Black (for Python) 等,直接格式化代码,或者借助工具查错

  1. 多 Review 多沟通
    工作中的大部分代码不是你一个人蛮干,自己的思维局限性,可以通过他人的视角打破。

Ref:

  1. Syntactic Sugar in Python
  2. 7 simple habits of the top 1% of engineers

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/622784.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

windows 设置ip命令bat脚本

您可以使用以下命令创建一个批处理文件&#xff08;.bat&#xff09;来添加IP地址&#xff1a; echo off set ipaddress set subnetmask set gatewaynetsh interface ip set address name"以太网" sourcestatic address%ipaddress% mask%subnetmask% gateway%gatewa…

【LV12 DAY17-18 中断处理】

GPX1_1是外部中断9 EINT9 查询可知其中断ID是57 所以需要进行人为修正lr的地址 sub lr&#xff0c;lr&#xff0c;#4 //iqr异常处理程序 irq_handler: //IRQ异常后LR保存的地址是被IRQ打断指令的下一条再下一条指令的地址&#xff0c;所以我们需要人为进行修正一下sub LR,L…

泛微OA-Ecology8表单中填充用友U8数据

文章目录 1、需求及效果1.1 需求1.2 效果 2、思路及实现步骤2.1 思路2.2 实现步骤 3.结语 1、需求及效果 1.1 需求 在OA中填写表单中时候&#xff0c;比如物料号还需要从U8中查找后才能填写&#xff0c;非常的麻烦。想要在填写表单的时候可以搜索&#xff0c;并且带出其他的关…

如何查看串口号和波特率?

serialport引入后&#xff0c;设备也接上了&#xff0c;一直不知道串口号和波特率去哪里找&#xff0c;当时这个问题困扰了我很久 将设备的线插入到电脑上的插口(串口)桌面的【此电脑】上右击选择管理&#xff0c;打开【设备管理器】在【端口】中找到对应的端口&#xff0c;如果…

textContent和innerText有什么区别

textContent 和 innerText 都是用于获取或设置元素的文本内容的属性&#xff0c;但它们之间有一些区别。 textContent 属性返回元素的所有文本内容&#xff0c;包括元素内部的所有文本和注释节点。而 innerText 属性仅返回元素内部可见的文本内容&#xff0c;忽略任何被 CSS 隐…

【linux】软链接创建(linux的快捷方式创建)

软连接的概念 类似于windows系统中的快捷方式。有的文件目录很长或者每次使用都要找很不方便&#xff0c;于是可以用类似windows的快捷方式的软链接在home&#xff08;初始目录类似于桌面&#xff09;上创建一些软链接方便使用。 软链接的语法 ln -s 参数1 参数2 参数1&#…

智慧园区数字孪生智能可视运营平台解决方案:PPT全文82页,附下载

关键词&#xff1a;智慧园区解决方案&#xff0c;数字孪生解决方案&#xff0c;数字孪生应用场景及典型案例&#xff0c;数字孪生可视化平台&#xff0c;数字孪生技术&#xff0c;数字孪生概念&#xff0c;智慧园区一体化管理平台 一、基于数字孪生的智慧园区建设目标 1、实现…

在钉钉群通过机器人发送信息

在第三方API接口对接中&#xff0c;需要及时获取第三方接口请求结果情况&#xff0c;所以在代码中融合钉钉机器人&#xff0c;对请求的异常结果及时发送通知。 自定义机器人参考链接通用响应参数-封装API的错误码 public interface IErrorCode {long getCode();String getMess…

SpringMVC零基础入门 - 概述、入门搭建、PostMan的使用(常见数据类型的传输)、REST风格编程

SpringMVC零基础入门 - 概述、入门搭建、PostMan的使用(常见数据类型的传输)、REST风格编程 SpringMVC是隶属于Spring框架的一部分&#xff0c;主要是用来进行Web开发&#xff0c;是对Servlet进行了封装SpringMVC是处于Web层的框架&#xff0c;所以其主要的作用就是用来接收前…

解决“win11无法识别U盘“问题

在15.6寸笔记本上插上U盘&#xff0c;有时候出现U盘无法识别的现象&#xff0c;出现这种问题的原因有许多&#xff0c;比如U盘的格式不被当前电脑支持、电脑的USB接口电压过低、没有安装U盘驱动等等。     若是U盘格式不支持&#xff0c;则把U盘改成电脑能够识别的格式&#…

字符串处理(将字符串中符合十六进制数据格式的数字和字符按照其对应的十进制数值进行累加) C语言xdoj704

题目描述&#xff1a; 输入由数字和字符构成的字符串&#xff08;不包含空格&#xff09;&#xff0c;将字符串中符合十六进制数据格式的数字和字符按照其对应的十进制数值进行累加&#xff0c;并输出累加结果&#xff0c;如果字符串中不含有任何满足十六进制格式的字符&#x…

论AI自动生成游戏的局限性及其意义缺失

近年来&#xff0c;人工智能技术在游戏开发领域的应用日益广泛&#xff0c;包括智能NPC设计、游戏关卡生成、剧情编排等。然而&#xff0c;关于让AI完全自主地编写和设计整个游戏的讨论也日渐兴起。本文旨在探讨为何让AI自己来写游戏在当前阶段并无实质意义&#xff0c;主要从创…

LC旋转矩阵

LC 旋转矩阵 题目描述&#xff1a; 给你一幅由 N N 矩阵表示的图像&#xff0c;其中每个像素的大小为 4 字节。请你设计一种算法&#xff0c;将图像旋转 90 度。 不占用额外内存空间能否做到&#xff1f; 题目示例如下&#xff1a; 示例一&#xff1a; 给定 matrix [[1,2…

CES 2024丨引领变革,美格智能为智能终端带来生成式AI能力

作为电子行业的“风向标”&#xff0c;CES 2024&#xff08;国际消费电子展&#xff09;于1月9日至12日在美国拉斯维加斯举办。本届展会可谓是AI的盛宴&#xff0c;芯片、AI PC、智能家居、汽车科技、消费电子等领域与AI相关的前沿成果接连发布&#xff0c;引领人工智能领域的科…

6.2 声音编辑工具GoldWave5简介(8)

2&#xff0e;降噪 如果声卡的质量不太好&#xff0c;在录音的过程中免不了会掺杂一些杂音&#xff0c;比如&#xff1a;电流声、爆破声等&#xff0c;此时就需要进行降噪处理。 (1) 选择【效果】|【波波器】|【噪声减小】命令&#xff0c;打开“降噪”对话框。如图6-2-14所示…

webpack 是什么?

webpack 是一个开源的 JavaScript 模块打包工具。它是前端开发中常用的构建工具之一&#xff0c;主要用于将项目中的多个模块和文件打包成一个或多个静态资源文件&#xff08;通常是 JavaScript 文件&#xff09;&#xff0c;以便在浏览器中加载和运行。 webpack 的主要功能包…

Pandas实战100例 | 案例 27: 数据合并 - 使用 `merge`

案例 27: 数据合并 - 使用 merge 知识点讲解 在数据处理中&#xff0c;经常需要将来自不同来源的数据集合并在一起。Pandas 提供了 merge 函数&#xff0c;它类似于 SQL 中的 JOIN 操作&#xff0c;可以根据一个或多个键来合并两个 DataFrame。 内连接 (inner): 只合并两个 …

Shell编程自动化之Shell数学运算与条件测试

一、Shell数学运算 1.Shell常见的算术运算符号 序号算术运算符号意义1、-、*、/、%加、减、乘、除、取余2**幂运算3、–自增或自减4&&、||、&#xff01;与、或、非5、!相等、不相等&#xff0c;也可写成6、、-、*、/、%赋值运算符&#xff0c;a1相等于aa1 2.Shell常…

记录一下常用的工具类

1.通用返回类 import lombok.Data;Data public class CommonResult<T> {private Integer code;private String message;private T data;//成功通用返回public static CommonResult okResult(Object data){CommonResult commonResult new CommonResult(AppHttpCodeEnum.…

chromium通信系统-ipcz系统(十一)-mojo binding

关于mojo binding的官方文档为mojo docs。 由于比较复杂&#xff0c;这里只做简单源码分析。 我们知道要实现rpc&#xff0c;必须实现客户端和服务端。 mojo 实现了一套领域语言&#xff0c;通过领域语言描述接口和数据&#xff0c; 再通过特有编译器编译成c代码。 这个过程会…