更新记录

1.0.0（2025-04-02） 下载此版本

支持 OpenAI / DeepSeek / 通义千问等 AI，一键生成 Vue 组件文档 自动解析 Vue 组件，提取 Props、事件、插槽、示例等信息 右键 Vue 文件直接生成 .md 文档 支持自定义 AI 模型 & API 地址

平台兼容性

HBuilderX插件通用注意事项

HBuilderX-2.7.12以下版本安装插件市场内的插件后，卸载时需手动卸载，详细教程参考：如何手动卸载插件

# First Extension For HBuilderX 开发文档参考：https://hx.dcloud.net.cn

ai-generate-md - Vue 组件文档生成器

✨ 插件介绍

ai-generate-md 是一个 HBuilderX 插件，可以使用 AI 自动生成 Vue 组件的 Markdown 文档，无需手写文档，大幅提高开发效率。

🚀 功能特点：

• 支持 OpenAI / DeepSeek / 通义千问等 AI，一键生成 Vue 组件文档
• 自动解析 Vue 组件，提取 Props、事件、插槽、示例等信息
• 右键 Vue 文件直接生成 .md 文档
• 支持自定义 AI 模型 & API 地址

📦 安装

1. 打开 HBuilderX，进入 插件市场
2. 搜索 ai-generate-md，点击 安装
3. 重启 HBuilderX，完成安装

🛠️ 配置 AI 模型

安装完成后，需要先配置 AI API Key 和模型：

1. 打开 HBuilderX 设置（Ctrl+Shift+P，输入 openGlobalSettings）
2. 在 ai-generate-md 配置项中填入：
   • ai-generate-md.apiKey：你的 OpenAI / DeepSeek / 千问 API Key
   • ai-generate-md.modelName：选择 AI 模型（支持 gpt-4、deepseek-chat 等）
   • 如果选择 "自定义" 模型：
     • ai-generate-md.zModelName：输入模型名称
     • ai-generate-md.zModelUrl：输入 API 地址

🖱️ 如何使用

方法 1：右键 Vue 文件

1. 在 explorer 文件管理器中 右键 .vue 组件文件
2. 选择 "AI生成组件文档"
3. 稍等片刻，Markdown 文档自动生成，并保存在同目录下

方法 2：命令面板

1. Ctrl+Shift+P 打开 命令面板
2. 输入 "AI生成组件文档" 并回车
3. 自动为当前打开的 Vue 文件生成文档

🎯 文档示例

以 MyComponent.vue 为例，生成的 .md 文档内容示例：

复制代码# MyComponent 组件文档

## 📌 组件介绍
`MyComponent` 是一个用于展示用户信息的 Vue 组件。

## ⚙️ Props 参数

| 参数名  | 类型   | 默认值  | 说明           |
|--------|------|------|--------------|
| `name` | `String` | `""` | 用户姓名     |
| `age`  | `Number` | `0`  | 用户年龄     |

## 🔥 事件说明

| 事件名   | 参数    | 说明         |
|---------|-------|------------|
| `click` | `无`   | 组件被点击时触发 |

## 🎨 插槽

| 插槽名 | 作用域   | 说明               |
|------|------|----------------|
| `default` | `无` | 组件的默认内容 |

## 📌 使用示例
```vue
<MyComponent name="张三" age="25" @click="handleClick">
  <template #default>
    <p>自定义内容</p>
  </template>
</MyComponent>

🛠️ 常见问题

1. 生成失败，提示 "请先配置 ai-generate-md"？

✅ 解决方案：

• 确保在 HBuilderX "设置" 中正确配置了 API Key 和模型
• 可以点击错误提示中的 "现在配置" 直接打开设置界面

2. 为什么 .md 文件没有生成？

✅ 检查以下内容：

• 确保 AI API Key 正确，且没有超出使用限制
• 右键的文件是否为 .vue 文件
• 网络是否正常，AI 接口是否可用

3. 支持哪些 AI 模型？

✅ 目前支持：

• OpenAI (gpt-4, gpt-3.5-turbo)
• DeepSeek (deepseek-reasoner, deepseek-chat)
• 通义千问 (qwen-plus, qwen-turbo)
• 支持自定义 AI API

🤝 反馈与支持

如果你有任何问题或建议，可以在 插件市场留言 🚀