接手舊程式看不懂?請 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