3-3 透过 Cursor 快速上手程式码库

2025年4月19日

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

在上一个单元中,我们谈了如何透过 Cursor 协助自己在撰写技术设计文件时,能够思考得更全面,并确保涵盖一些极端案例或需要考量的细节。然而,在进行技术设计之前,先了解既有的程式码库是非常重要的。这不仅能帮助我们进行技术设计,还能在实际实作时以更有效率的方式进行。因此,在这个单元中,我们将进一步讲解如何在进入技术设计或实作之前,透过 Cursor 快速上手程式码库。

为什么要先了解既有程式码库?

正如我们前面提到的,在进行技术设计或实作之前,先了解既有的程式码是非常关键的,

原因包括:

  • 避免设计与实作模式不一致:如果程式码库已经有一个既定的模式或风格,在设计或实作时采用不同的方式,就可能导致程式码库出现不一致的情况。这种不一致对于未来维护程式码的人来说会造成困扰。举例来说,维护者在阅读程式码时,可能会发现某个地方使用 A 模式,而另一个地方解决类似问题却使用 B 模式。这会让人疑惑,不确定未来新增功能或改动时,到底该采用哪种模式?为了避免这种困惑,确保程式码库的风格和模式一致非常重要,而这需要从设计和实作前了解开始。
  • 辨别出可重复利用的资源:在设计和实作之前了解程式码库,还能帮助我们知道有哪些现有的资源可以重复利用,避免重复造轮子。这样不仅能节省时间,直接使用既有功能而非从头开发,也能减少未来维护者需要理解的程式码量,让维护工作更轻松。

这些概念听起来很理论化,大多数人都会同意「先了解程式码库很重要」。那么实际上,我们该如何利用 Cursor 来做到这一点呢?

如何透过 Cursor 快速上手程式码库?

接下来,我们以一个具体场景为例:假设刚加入一个团队,拿到了一个 AI 相关的开源专案。把这个专案拉到本地后,对程式码库完全不熟悉。以下是如何透过 Cursor 快速理解程式码库的方法:

方法一:使用 Agent Mode 理解整体架构

一个简单的方式是使用 Cursor 的 Agent Mode(快捷键 Command + I),然后输入提示词,例如:「我刚加入这个团队,对程式码库还不熟悉,请协助我理解目前程式码库的架构。」送出后,Cursor 会自动扫描整个程式码库。例如,它可能会展开多个档案,查看其中的 README、不同模组和架构细节,并在分析后提供高层次的总结。

使用 Cursor 的 Agent Mode 理解整体架构
使用 Cursor 的 Agent Mode 理解整体架构

Cursor 还会在结尾提示:「如果需要了解任何特定部分的细节,欢迎提问。」此时,如果想深入了解某部分,可以进一步提问。透过这种方式,我们可以快速从高层次架构深入到实作细节,对不熟悉的程式码库建立全面的认识。

方法二:搜寻现有功能,避免重复开发

另一个实用的功能是,当你想实作某个新功能时,可以透过 Cursor 的 AI Agent 检查程式码库是否已有相关方法或函数,避免重新开发。假设我想在专案中新增一个处理 Markdown 格式的功能,传统做法可能是在搜寻栏输入「Markdown」,但结果可能会出现大量相关但不精确的内容,需要花时间逐一检查。

有了 Cursor,可以直接问:「我想处理语言模型回传的 Markdown 格式,确保呈现给使用者的是精美格式,目前程式码库有没有相关的转换或呈现方法?」送出后,Cursor 会扫描程式码库,分析相关档案,并快速列出处理 Markdown 格式时使用了哪些元件、具体采用了哪些函数或方法。

Cursor 分析程式码库,找出所需要的函式
Cursor 分析程式码库,找出所需要的函式

透过这个方式,就能在实作前确认,节省时间并避免重复造轮子。

总结

在过去,要快速理解程式码库风格、判断程式码库是否有可重复利用的资源,通常需要资深工程师对程式码有一定熟悉度。

但现在有了 Cursor,即使是新加入团队的人、新手工程师,或是转换到不同专案的人,都能透过上述方式快速上手程式码库。不论是理解整体架构、深入细节,还是检查现有功能,Cursor 都能大幅提升效率。因此,非常推荐大家在接触新程式码库时,试着用这种方式来加速学习和实作。

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

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