---

name: c4-code description: C4 代码级文档专家。分析代码目录以创建全面的 C4 代码级文档，包括函数签名、参数、依赖关系和代码结构。 risk: unknown source: community date_added: '2026-02-27'

C4 代码级别：[目录名称]

何时使用此技能

• 处理 C4 代码级别：[目录名称] 任务或工作流时
• 需要 C4 代码级别：[目录名称] 的指导、最佳实践或检查清单时

何时不使用此技能

• 任务与 C4 代码级别：[目录名称] 无关时
• 需要此范围之外的其他领域或工具时

说明

• 明确目标、约束和所需输入。
• 应用相关最佳实践并验证结果。
• 提供可操作的步骤和验证。
• 如需详细示例，请打开 resources/implementation-playbook.md。

概述

• 名称：[此代码目录的描述性名称]
• 描述：[此代码功能的简短描述]
• 位置：[实际目录路径链接]
• 语言：[主要编程语言]
• 用途：[此代码完成的功能]

代码元素

函数/方法

• functionName(param1: Type, param2: Type): ReturnType
  • 描述：[此函数的功能]
  • 位置：[文件路径:行号]
  • 依赖：[此函数依赖的内容]

类/模块

• ClassName
  • 描述：[此类的功能]
  • 位置：[文件路径]
  • 方法：[方法列表]
  • 依赖：[此类依赖的内容]

依赖关系

内部依赖

• [内部代码依赖列表]

外部依赖

• [外部库、框架、服务列表]

关系

可选的 Mermaid 图表用于复杂代码结构。根据编程范式选择图表类型。代码图展示单个组件的内部结构。

面向对象代码（类、接口）

对于具有类、接口和继承的 OOP 代码使用 classDiagram：

---
title: Code Diagram for [Component Name]
---
classDiagram
    namespace ComponentName {
        class Class1 {
            +attribute1 Type
            +method1() ReturnType
        }
        class Class2 {
            -privateAttr Type
            +publicMethod() void
        }
        class Interface1 {
            <<interface>>
            +requiredMethod() ReturnType
        }
    }

    Class1 ..|> Interface1 : implements
    Class1 --> Class2 : uses

函数式/过程式代码（模块、函数）

对于函数式或过程式代码，有两个选项：

选项 A：模块结构图 - 使用 classDiagram 展示模块及其导出函数：

---
title: Module Structure for [Component Name]
---
classDiagram
    namespace DataProcessing {
        class validators {
            <<module>>
            +validateInput(data) Result~Data, Error~
            +validateSchema(schema, data) bool
            +sanitize(input) string
        }
        class transformers {
            <<module>>
            +parseJSON(raw) Record
            +normalize(data) NormalizedData
            +aggregate(items) Summary
        }
        class io {
            <<module>>
            +readFile(path) string
            +writeFile(path, content) void
        }
    }

    transformers --> validators : uses
    transformers --> io : reads from

选项 B：数据流图 - 使用 flowchart 展示函数管道和数据转换：

---
title: Data Pipeline for [Component Name]
---
flowchart LR
    subgraph Input
        A[readFile]
    end
    subgraph Transform
        B[parseJSON]
        C[validateInput]
        D[normalize]
        E[aggregate]
    end
    subgraph Output
        F[writeFile]
    end

    A -->|raw string| B
    B -->|parsed data| C
    C -->|valid data| D
    D -->|normalized| E
    E -->|summary| F

选项 C：函数依赖图 - 使用 flowchart 展示函数之间的调用关系：

---
title: Function Dependencies for [Component Name]
---
flowchart TB
    subgraph Public API
        processData[processData]
        exportReport[exportReport]
    end
    subgraph Internal Functions
        validate[validate]
        transform[transform]
        format[format]
        cache[memoize]
    end
    subgraph Pure Utilities
        compose[compose]
        pipe[pipe]
        curry[curry]
    end

    processData --> validate
    processData --> transform
    processData --> cache
    transform --> compose
    transform --> pipe
    exportReport --> format
    exportReport --> processData

选择正确的图表

| 代码风格 | 主要图表 | 何时使用 | | -------------------------------- | -------------------------------- | ---------------------------------------------- | | 面向对象（类、接口） | classDiagram | 具有继承和多态的 OOP 代码 | | 函数式（模块、导出函数） | classDiagram（模块结构） | 展示模块边界和导出 | | 管道/数据流 | flowchart LR | 数据转换序列 | | 复杂调用图 | flowchart TB | 函数间依赖关系 |