维护文档最耗时的往往不是初次编写，而是代码迭代后文档忘记同步。CodeBuddy 支持基于当前代码直接生成接口说明和技术文档，省去大量手动排版与格式调整的工作。
接口文档生成
适用于 RESTful API、RPC 接口或函数库对外暴露的方法。
- 单接口快速生成：选中某个 Controller 方法、API 路由处理函数或接口定义，在侧边栏对话中输入"生成接口文档"。CodeBuddy 会自动解析函数签名、参数类型、返回值，并输出包含 URL、Method、请求参数、响应示例的 Markdown 或 YAML 格式文档片段。
- 批量生成：通过
@文件或@目录（见 3.4 节）引用整个接口层（如 Spring Boot 的controller目录、Express 的routes目录），输入"批量生成 API 文档"，可一次性输出全量接口清单，适合直接导入 YApi、Postman 或内部 Wiki。 - 代码内注释补全：若团队采用 Swagger/OpenAPI、JavaDoc、JSDoc 等规范，可直接要求生成对应格式的注释块并插入到代码上方（与 3.3.4 标准化注释批量生成配合使用）。
技术文档生成
面向项目 README、模块说明、架构梳理等场景。
- 项目 README：通过
@目录绑定项目根目录，输入"生成项目 README"，CodeBuddy 会结合package.json、pom.xml、目录结构和核心入口文件，自动生成包含项目简介、安装步骤、目录说明的 Markdown 文档，你只需补充业务背景与特殊部署说明。 - 模块技术说明：针对复杂业务模块，选中核心文件或引用模块目录后，要求"输出模块技术说明"，可获得流程概述、关键类职责、数据流转描述，方便粘贴到内部技术 Wiki。
- 变更对比：若已有旧版接口文档，将文档内容粘贴进对话，并
@文件引用最新实现，要求"对比代码变更更新文档"，可快速定位出入参、返回结构的变化点。
格式与规范控制
在对话中明确指定输出格式，结果更可直接使用：
- "生成 Markdown 表格格式的参数说明"
- "按 Swagger 2.0 规范补全 annotations"
- "用中文输出，技术术语保留英文"
如果团队已配置文档模板或编码规范（通过 3.4.4 的 @规则 导入），生成的文档会自动遵循预设的标题层级、字段命名和排版风格。
实用提示
- 业务语义需人工校准：CodeBuddy 能准确识别参数类型与结构，但参数的业务含义（如
status=2代表"已审核"还是"已驳回"）需要你自己补充或校对。 - 敏感信息脱敏：生成对外文档时，注意检查是否意外暴露了内部接口路径、调试接口或敏感字段，必要时在提示词中加上"隐藏内部管理接口"。
- 增量维护优于全量重写：接口迭代时，仅选中变更的函数重新生成文档片段，再替换旧文档对应部分，比整体重新生成更高效。