c4-code

C4代码级文档专家。专责分析代码目录,生成包含函数签名、参数说明、依赖关系及代码结构的完整C4代码级文档。适用于针对独立目录与代码模块进行最细粒度C4层级的代码文档编制工作。

作者

安装

热度:23

下载并解压到你的 skills 目录

复制命令,发送给 OpenClaw 自动安装:

下载并安装这个技能 https://openskills.cc/api/download?slug=sickn33-skills-c4-code&locale=zh&source=copy

c4-code:C4 代码级文档生成专家

技能概述

c4-code 是 C4 模型中的代码级文档生成专家,专门用于分析代码目录并创建详细的函数签名、参数类型、依赖关系和代码结构文档。

适用场景

1. 代码库文档化

当你接手一个新项目或维护遗留代码时,c4-code 可以快速分析代码目录,生成包含函数签名、类结构、模块依赖的完整文档,帮助团队理解代码设计意图和实现细节。

2. 架构设计记录

在软件架构设计中,C4 模型的代码级视图是最底层的细节展示。c4-code 能够将实际代码转换为结构化的 Mermaid 图表(类图、流程图、依赖图),让架构文档与代码实现保持同步。

3. 代码重构与审查

重构前需要了解现有代码的依赖关系,代码审查时需要快速理解函数职责。c4-code 提供的代码级文档可以清晰展示函数间的调用关系、类的继承层次和模块的依赖结构。

核心功能

1. 代码元素分析

自动分析代码目录中的函数、方法、类和模块,提取完整的函数签名(包括参数类型和返回类型)、类属性和方法列表,并标注每个元素在源码中的具体位置(文件路径和行号)。

2. 依赖关系映射

识别代码的内部依赖(模块间调用关系)和外部依赖(第三方库、框架),生成结构化的依赖列表,帮助理解代码的耦合度和影响范围。

3. 多范式图表生成

根据代码编程范式自动选择合适的 Mermaid 图表类型:面向当代码生成类图展示继承和接口实现;函数式代码生成流程图展示数据管道;混合范式代码支持组合使用多种图表类型。

常见问题

c4-code 技能支持哪些编程语言?

c4-code 能够分析多种主流编程语言,包括但不限于 Python、JavaScript/TypeScript、Java、Go、Rust、Elixir 等。技能会根据代码特征自动识别编程范式(面向对象、函数式、过程式)并选择合适的文档模板和图表类型。

c4-code 生成的代码文档包含哪些内容?

输出文档包含完整的代码元素列表(函数签名、类定义、模块导出)、每个元素的描述和源码位置链接、内部和外部依赖清单,以及根据代码复杂度自动生成的 Mermaid 结构图(类图、流程图或依赖图)。

c4-code 与 c4-component 技能有什么区别?

c4-code 聚焦于单个代码目录或模块的微观层面,分析具体的函数、类和它们的依赖关系;而 c4-component 从更高层次综合多个代码文件,将它们抽象为系统组件。c4-code 是 C4 模型中最底层的视图,适用于需要深入代码细节的场景。