3-7 透过 Cursor 协助 Code Review

2025年4月19日

持續學習最新的 AI 應用
更多深入的 AI 內容,都在 E+ 成長計畫 👉前往了解

在前面的单元中,我们分别探讨了如何使用 Cursor 撰写生成 commit 讯息以及编写 PR 的描述。在这个单元,我们将进一步介绍如何在团队中协助进行 code review ,并利用 Cursor 来提升效率。

假设你是新加入团队的人,对团队的程式码库还不熟悉;或者你是一个刚毕业的新人,对如何进行 code review 缺乏经验;又或者你是资深工程师,在完成自己的 code review 后想确保评审足够全面。在这些情况下,Cursor 都能派上用场。接下来,我们透过实际展示来说明如何利用 Cursor 进行 code review 。

操作步骤

要使用 Cursor 进行 code review ,首先建议将团队其他成员提交的 PR 拉到自己的本地端,然后切换到该 PR 使用的分支。接着,可以利用前面提到过的 @git 指令,调出该分支相关的 Git 历史纪录。这样就能针对某个 commit 或该分支与主分支之间的差异进行审查。

这边推荐一个重要的前提,是团队要有一份风格指南 (Style Guide)。风格指南能确保程式码的一致性,举例来说,Airbnb 提供的开源 JavaScript 风格指南,在 GitHub 上获得超过 10 万颗星,明确规范了撰写 JavaScript 的风格。Google 也公开了多种程式语言 (如 C++、Go、JavaScript、Java 等) 的风格指南,供开发者参考。

将风格指南融入 Cursor

有了风格指南后,可以将其加入 Cursor 的文件中。具体做法是:

  • 在 Cursor 的 Features 中找到「Docs」功能
  • 将风格指南文件加入
  • 在审查时,直接引用这些指南,例如输入「用 JavaScript Style Guide 来 Review 某个 PR」
在 Cursor 中新增风格指南
在 Cursor 中新增风格指南

提交后,Cursor 会根据风格指南分析程式码,并提出建议,确保 PR 中的程式码与整体程式码库的风格一致。

请 Cursor 根据 JavaScript 风格指南 code review
请 Cursor 根据 JavaScript 风格指南 code review

利用决策脉络进行审查

除了风格指南,我们之前提到的决策脉络纪录,也能用于 code review。除了用 @Git ,在用 Cursor 看程式码时,不一定只能针对整个 PR。也可以锁定单一档案或程式码片段进行审查。例如,将某个 React 元件档案引用进来,让 Cursor 根据 React 的原则提出改进建议。

提升 Code Review 的友善性与建设性

在进行 code review 时,有一个非常值得注意的重点:用词需谨慎,避免情绪化或冲动的表达。特别是当团队成员犯了不该犯的错误,或重复出现你之前已指出的问题时,有些人可能会感到不耐烦,导致评语语气变差。然而,若想打造正向且持续成长的团队文化,应避免使用带有情绪的字眼。

具体做法是,在 Cursor 中新增提示词,例如「请帮我将 code review 文字改得更友善、有建设性且专业」。将带有情绪的评语贴进去,例如:「这边写法很糟糕,可读性超差,特定 magic number 应该抽出来,之前不是说过不要这样写吗?怎么讲不听?!!!」

提交后,Cursor 会将这段文字改进为更专业且友善的版本。这样的调整能确保 code review 聚焦于程式码而非个人,并以理性、有建设性的方式进行,从而提升团队文化。

Cursor 协助把情绪化的评语改为理性且友善的版本
Cursor 协助把情绪化的评语改为理性且友善的版本

此系列文章为 《给工程师的 Cursor 工作流 — 透过 AI 代理全方位提升开发生产力》 搭配的教材。希望透过这系列文章,将过去协助导入 AI 工具及使用 Cursor 的经验扩展并分享给想提升生产力的读者。如果对课程感兴趣的读者,可以加入 E+ 成长计划,观看影片学习。

🧵 如果你想收到最即時的內容更新,可以在 FacebookInstagram 上追蹤我們