接手旧代码看不懂?请 GitHub Copilot 梳理阅读路线

把入口文件与相关模块提供给 Copilot,整理带文件位置的调用流程与待确认问题,再沿着源代码逐项核对。

执行环境与使用方式

AI/软件

GitHub Copilot

在哪里操作

代码编辑器内的 GitHub Copilot Chat;以 VS Code 为入门路径。

如何开始

  1. 在 VS Code 安装并登录 GitHub Copilot,打开项目副本。
  2. 在 Copilot Chat 加入相关代码上下文,粘贴代码阅读要求;先审阅回答。

准备与方案条件

需要 Copilot 使用权及兼容编辑器;执行测试另需项目语言、依赖包与测试工具。只阅读代码不需执行权限。

提示词移植限制

可把去敏代码片段与问题交给其他代码助手;项目上下文、工具调用与测试环境不会自动转移。

使用限制

此案例不要求 Agent 模式或自动执行命令;若另启用代理,须逐项确认文件及终端权限。

环境资料来源

適用情境 / When to use

把入口文件与相关模块提供给 Copilot,整理带文件位置的调用流程与待确认问题,再沿着源代码逐项核对。 AI 可能漏看动态呼叫、设定或执行时差异。

步驟 / Steps

  1. 提供入口档、相关模组和执行方式。
  2. 要求以档案与函式位置说明呼叫链。
  3. 沿著引用读原码,将不确定之处列为待验证。

提示詞 / Prompt

先不要修改档案。从[入口档]追踪[功能]的资料流,列出输入、主要函式、输出与副作用,每项附档案位置。区分程式码直接显示的事实和你的推测,最后给我一条最短阅读路线。

留意事項 / Cautions

  • AI 可能漏看动态呼叫、设定或执行时差异。
  • 架构解释需透过原码与测试验证,不能凭空补写。

GitHub Blog:Documenting and explaining legacy code