المهارات code-documentation-code-explain
📦

code-documentation-code-explain

آمن

使用視覺圖表解釋複雜程式碼

開發人員在理解複雜程式碼庫和快速入職方面遇到困難。此技能將困難的程式碼轉化為清晰的說明，包含視覺圖表、逐步分解和互動式範例。

يدعم: Claude Codex Code(CC)
📊 70 كافٍ
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "code-documentation-code-explain". 使用視覺圖表解釋此裝飾器模式

النتيجة المتوقعة:

裝飾器目的的高層級摘要、顯示包裝關係的 Mermaid 類別圖、逐步執行流程、真實世界類比，以及包含前後對比的程式碼範例

استخدام "code-documentation-code-explain". 視覺化逐步引導此遞迴函數

النتيجة المتوقعة:

帶有樹狀圖的呼叫堆疊視覺化，顯示每個遞迴呼叫、基底情況說明、傳回值傳播動畫，以及具有大 O 符號的複雜度分析

التدقيق الأمني

آمن
v1 • 2/25/2026

Static analysis flagged 71 patterns in markdown documentation containing educational Python code examples. All findings are false positives - the detected patterns (shell commands, URLs, crypto references) exist only in code samples for teaching purposes, not in executable skill logic. The skill is a documentation and code explanation tool with no actual command execution, network access, or filesystem operations.

2
الملفات التي تم فحصها
852
الأسطر التي تم تحليلها
4
النتائج
1
إجمالي عمليات التدقيق
مشكلات متوسطة المخاطر (1)
resources/implementation-playbook.md:12-789SKILL.md:37-48
Static Analysis False Positive - External Commands
Static scanner detected 'Ruby/shell backtick execution' patterns in markdown code blocks. These are fenced code blocks (```python, ```mermaid) in documentation, not actual shell execution. The skill contains only educational examples.
مشكلات منخفضة المخاطر (3)
resources/implementation-playbook.md:750
Static Analysis False Positive - Network URL
Hardcoded URL detected at line 750 is a learning resource link (https://realpython.com/async-io-python/) in educational content, not actual network code executed by the skill.
resources/implementation-playbook.md:46-757SKILL.md:3-26
Static Analysis False Positive - Cryptographic Algorithm
Weak cryptographic algorithm patterns detected in educational code examples within markdown documentation. These are teaching examples, not executable code used by the skill.
resources/implementation-playbook.md:107-797
Static Analysis False Positive - System Reconnaissance
System reconnaissance patterns detected in educational Python code samples. These are demonstration examples for teaching code analysis concepts, not actual reconnaissance functionality.
تم تدقيقه بواسطة: claude

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
32
المجتمع
94
الأمان
91
الامتثال للمواصفات

ماذا يمكنك بناءه

開發人員入職

透過視覺圖表和漸進式說明，幫助新團隊成員了解現有程式碼庫結構、關鍵元件和設計模式。

學習複雜演算法

逐步分解排序演算法、遞迴和資料結構，並透過顯示每個執行狀態的逐步視覺化來說明。

程式碼審查文件

產生對複雜拉取請求的清晰說明，突顯所使用的設計模式、潛在陷阱和最佳實踐建議。

جرّب هذه الموجهات

基本程式碼說明 
解釋這段程式碼：[貼上程式碼]。請包含高層級摘要並識別所使用的關鍵程式設計概念。
流程圖產生 
分析此函數並產生 Mermaid 流程圖，顯示執行流程、決策點和函數呼叫：[貼上程式碼]
演算法視覺化 
逐步逐步引導此演算法，並顯示資料在每次迭代中如何變化的視覺化：[貼上排序/搜尋演算法]
設計模式分析 
識別此程式碼庫中的設計模式，並用類別圖解釋每個模式的好處、缺點和替代方法：[貼上程式碼]

أفضل الممارسات

  • 在深入實作細節之前，先從高層級概述開始
  • 結合文字說明使用視覺圖表以獲得更好的理解
  • 提供漸進式複雜度 - 先提供初學者說明，然後再深入進階細節

تجنب

  • 在建立整體目的之前逐行解說程式碼
  • 使用術語而不為目標受眾程度定義術語
  • 只提供文字說明，而應使用視覺圖表來釐清流程

الأسئلة المتكررة

此技能支援哪些程式設計語言？
此技能在 Python 和 JavaScript 上效果最佳，因為有廣泛的模式庫，但可以解說大多數主流語言的程式碼，包括 Java、Go、Rust 和 TypeScript。
此技能可以為任何程式碼產生圖表嗎？
圖表以 Mermaid 格式產生，可在大多數 Markdown 檢視器中呈現。支援流程圖、類別圖和序列圖。複雜的巢狀邏輯可能需要簡化表示。
此技能會執行或測試它分析的程式碼嗎？
不，此技能僅靜態分析和解說程式碼。它不會執行、運行或測試程式碼。所有說明都基於程式碼結構的靜態分析。
逐步說明有多詳細？
說明是漸進式的 - 從簡單概述開始，然後深入關鍵元件。您可以要求特定章節的更多細節，或請求初學者/進階程度的說明。
此技能可以幫助理解除錯嗎？
是的，此技能可以透過追蹤執行流程、識別邊緣情況和突顯程式碼結構中的常見陷阱來解說錯誤發生的原因。
此技能適合完全不會程式的初學者嗎？
是的，說明包含簡單的類比並漸進地建立複雜度。請指定您的經驗程度以獲得適當目標的說明。

تفاصيل المطور

المؤلف

sickn33

الترخيص

MIT

المستودع

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-code-explain

مرجع

main

بنية الملفات

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md