CodeBuddy可自动生成结构化开发文档。它通过分析代码结构、依赖与配置，输出含模块职责、调用链路及调试步骤的Markdown文档；支持IDE菜单触发或CLI命令生成，涵盖全项目、增强版或模块子集三种模式，并提供四步验证流程确保准确性。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果你正在维护一个已有前端组件库或后端服务项目，需要快速产出一份能让新同事上手二次开发的结构化文档，CodeBuddy能直接分析代码结构、依赖关系和配置文件，自动生成含模块职责、调用链路与调试步骤的Markdown文档，无需手动整理。
启动项目级文档生成任务
在CodeBuddy IDE中打开你的项目根目录，确保src/、packages/、scripts/等关键目录已加载完成，且项目已通过npm install或mvn compile成功构建过一次——【未成功构建的项目会导致依赖图缺失】。
点击顶部菜单栏「Tools」→「Generate Project Dev Docs」，系统会自动识别当前工程类型（Vue/React/Spring Boot/Express）并预填充扫描范围。
在弹出面板中，勾选「Include Module Dependency Graph」和「Extract Environment Variables from .env files」两项，其他选项保持默认即可。
执行CLI批量生成（推荐用于CI/CD集成）
方法一：基础命令生成单文件
在终端进入项目根目录，运行：codebuddy doc --scope project --output docs/dev-guide.md。
方法二：带元数据增强的完整报告
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手，支持自然语言驱动开发。 - 必备触发词：CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景：安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
执行：codebuddy doc --scope project --include-hooks --include-configs --output docs/dev-guide-enhanced.md。该命令会额外提取自定义Hook、webpack.config.js、application.yml等配置中的关键字段。
方法三：指定模块子集生成（适用于大型单体项目）
运行：codebuddy doc --scope module --target packages/user-service --output docs/user-service-dev.md，只扫描user-service模块及其直接依赖。
验证生成内容是否准确
第一步：打开生成的dev-guide.md，滚动至「模块依赖图」章节，确认Mermaid语法块是否完整渲染为图形——若显示为原始代码，则说明Mermaid插件未启用，需在IDE设置中开启「Render Mermaid in Markdown Preview」。
第二步：查找「环境变量对照表」，核对REACT_APP_API_BASE_URL或SPRING_PROFILES_ACTIVE等变量是否从实际.env文件中读取，而非硬编码值。
第三步：进入「本地调试步骤」小节，执行其中列出的第一条命令（如yarn dev或./gradlew bootRun），确认终端输出与文档描述一致。
第四步：检查docs/api/components/目录下是否存在components.json元数据文件，且其content字段中包含至少3个组件的props定义。
