代码结构分析

技能文档

---
name: diegosouzapw-analyze-code-structure
title: 代码结构分析
category: 开发工具
description: 检查代码组织方式并识别结构性模式，快速摸清一个代码库的模块层次、主要组件与依赖关系。当用户需要初步评审代码库、了解现有模块组织、为文档梳理代码结构，或计划重构与重新组织代码时触发。触发词：代码结构分析、模块层次、代码库梳理、重构规划。
---

# 代码结构分析

检查代码组织、模块层次与结构性模式，理解各组件是如何被组织起来的。

## 技能工作流

按以下顺序执行，每一步都对应后续小节：

### 步骤1：纵览代码库

识别顶层模块与包，确定项目的技术栈和组织风格：

```bash
# 快速摸底代码结构
find . -name "*.py" -o -name "*.js" -o -name "*.ts" -o -name "*.go" | head -20
tree -L 2 --dirsfirst
grep -r "^class\|^def\|^fn\|^struct\|^interface" --include="*.py" --include="*.go" --include="*.ts" | head -30
```

### 步骤2：绘制模块层次

用树状图呈现模块组织关系，标出入口（main/入口文件）、核心包与外围工具包。

### 步骤3：列出主要组件

按模块归纳类、结构体和重要函数，注明各自职责；只列主干，不逐个罗列工具函数。

### 步骤4：追踪导入依赖

梳理模块间的 import/include 关系，找出循环依赖、过度耦合和边界模糊的模块。

### 步骤5：输出结构文档

把分析结果汇总成团队可用的结构说明。

## 输出格式

结构分析报告包含：

- 模块/包层次（树状视图）
- 各模块的关键组件
- 导入依赖关系
- 分层组织（如适用）
- 显著的设计模式（MVC、单例、工厂等）

## 深入分析建议

- 需要更细粒度时，对单个模块重复上述流程并下沉一层
- 需要架构层面的评估时，在结构分析基础上补充架构决策与演进建议
- 设计原则可对照仓库内已有的架构说明文档（如存在）

使用说明

# 代码结构分析

快速摸清任意代码库的模块层次、主要组件与依赖关系，输出团队可直接使用的结构说明。

## 使用

对 Agent 说「帮我分析一下这个项目的代码结构」，或在代码库根目录直接运行摸底命令：

```bash
tree -L 2 --dirsfirst
grep -r "^class\|^def\|^fn\|^struct" --include="*.py" | head -30
```

## 工作原理

按五步流程执行：纵览代码库 → 绘制模块层次 → 列出主要组件 → 追踪导入依赖 → 输出结构文档。
报告涵盖模块树、各模块关键组件、依赖关系、分层组织与显著设计模式（MVC、单例、工厂等），
适用于代码库评审、项目接手、文档编写与重构规划。

如何安装此技能？

访问技能市场，点击「安装」按钮，按提示将技能包放入 AI 编程助手的 skills 目录即可。