关于Code Review
介绍
源作者链接:https://blog.kndb.in/code-reviews-used-to-hate-them-not-anymore
正文
Developers = 患有轻度强迫症的疯狂个体。
对他们的操作系统、他们使用的编辑器、他们使用语言结构的方式有特殊要求的人。
在这篇文章中,我将谈谈这种疯狂是如何使代码审查变得更加疯狂的。
Hello 混乱
想象一下,10个这样的人在一个项目上工作,每个人都有自己的一套偏好。
- 有些人喜欢大括号在行内,有些人在下一行。
- 有些人喜欢在if括号前加空格,有些人不喜欢。
- 有些人喜欢在逻辑运算前后加空格,有些人则希望它们尽可能地紧凑。
你会明白的。
A作为一个评审员,这就是你在代码评审中可能最终看到的情况。实际的代码修改到底在哪里?也是在我的脑海里->🤬
虽然我从来没有玩过Waldo,但我在互联网上看到过备忘录,当我收到第一个 "疯狂 "的审查请求时,我首先想到的就是它。
在一个团队中拥有一致的编码风格是至关重要的,团队中的每个开发人员都应该同意以同样的方式使用语言功能,这将使审查员的生活变得更加轻松。但你如何执行这一点呢?我们将在下一节中讨论这个问题。
如果你还想知道代码的变化是什么,那就来看看吧
这同样没有任何意义,在for循环的背景下,++i和i++是一样的。
我们如何执行代码的一致性
⭐EditorConfig⭐
这个漂亮的小配置文件可以帮助多个开发人员在不同的编辑器和集成开发环境中对同一个项目保持一致的编码风格。
😋 最棒的部分
- 支持多种编辑器。
- 适用于多种文件类型。
- 这些设置优先于你的编辑器设置,这意味着你可以为你的代码库强制执行一致的编码风格,这些设置是特定于一个资源库的。
🧱 创建一个(我将使用Visual Studio,因为这是我喜欢的IDE,你喜欢的IDE应该有类似的步骤)。
你所要做的就是在你的项目解决方案上点击右键,添加一个新的编辑器config
这将选择你在Visual Studio实例中的所有编辑器设置,并将其放入代码库中的.editorconfig文件。现在你可以把它推送到你的远程版本库。你也应该和你的同事们联系,确保他们都同意你的设置。一旦他们把这个文件拉到他们的本地,他们的偏好就会被覆盖。
你也可以去Github,搜索.editorconfig,看看其他人是如何在他们的仓库中创建这些配置的。
😩 Visual Studio中的注意事项
Editorconfig的设置在Visual Studio中不会自动使用,你必须每次都执行代码清理。你可以安装扩展程序,在保存操作时运行代码清理来克服这个问题。在我看来,微软应该将此作为默认行为。
Editorconfig让我和我的团队的代码审查变得更加简单,让它现在更容易忍受😜,强烈推荐。
谢谢你看完这篇文章。我希望你觉得它很有用。谢谢