Communitygithub.com

Adamska1008/以代碼解釋

一個靜默的代理技能,將與代碼相關的對話紮根於來源引用和程式碼片段中。

以代碼解釋 是什麼?

「以代碼解釋」是一個專為 AI 代理(如 Claude Code、Cursor、Codex 等)設計的技能,旨在使代理在解釋程式碼庫時,始終以實際原始碼作為主要證據來源。它要求代理在解釋前先檢查相關檔案(除非使用者已提供確切程式碼),並在主要論點中包含具體檔案引用與行號。對於每個重要行為,技能指導代理引用或總結最小且有用的程式碼片段,避免脫離來源的廣泛描述。此外,它還規範解釋應涵蓋程式碼如何組合:包含進入點、呼叫流程、資料流、狀態變更、副作用及邊界情況。若無法檢查程式碼或證據不完整,技能要求代理明確說明,並將推測與驗證過的來源事實分開。整體解釋結構建議以簡短答案開頭,再以程式碼錨定細節,最終形成可讀性高且以證據為基礎的說明。此技能支援所有主要 AI 開發代理平台,透過標準化的 SKILL.md 檔案進行整合。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add Adamska1008/explain-with-code

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

以代碼解釋 是做什麼的?

在解釋專案時,讓程式碼成為證據。

  1. 在解釋之前,先檢查相關檔案,除非使用者已經提供了確切的程式碼。
  2. 對於主要論點,包含具體的檔案引用及行號。
  3. 針對每個重要行為,引用或總結最小且有用的程式碼片段;避免撰寫未與原始碼連結的廣泛文字。
  4. 解釋引用的程式碼如何組合在一起:進入點、呼叫流程、資料流、狀態變更、副作用以及邊界情況。
  5. 如果無法檢查程式碼或證據不完整,請清楚說明,並將推測與經過驗證的來源事實分開。
  6. 保持解釋的可讀性:先給出簡短答案,再將細節錨定在程式碼中。

偏好以下結構:

簡短答案。

相關路徑始於 `path/to/file.ext:line`,其中 ...

```language
小而聚焦的程式碼片段
```

這會呼叫 `path/to/other.ext:line` 中的 `symbol`,進而 ...

相關技能