AI Comment Generator

一个强大的 VSCode 插件，使用 AI 为代码自动生成注释。支持 C++、Python、Lua、Java、JavaScript 和 TypeScript。

功能特性

🤖 使用 AI 自动生成代码注释
🌍 支持多种编程语言（C++、Python、Lua、Java、JavaScript、TypeScript）
📝 支持为选中代码或整个文件生成注释
⚙️ 可配置的 AI 服务提供商（OpenAI、Anthropic 等）
🌐 支持中英文注释生成
⚡ 智能缩进对齐，自动匹配代码风格
📊 进度指示器，实时显示生成状态
🛡️ 大文件警告，避免意外消耗过多 API 配额
🔄 配置热更新，修改设置后立即生效

安装

在 VSCode 中打开扩展面板
搜索 "AI Comment Generator"
点击安装

或者从源码安装：

npm install
npm run compile
# 按 F5 在扩展开发宿主中运行

配置

重要：在使用插件之前，必须先配置 AI API 密钥！

快速配置

方法一：通过命令面板
- 按 Cmd/Ctrl + Shift + P 打开命令面板
- 输入 "AI Comment: Open Settings"
- 配置你的 API 密钥
方法二：通过设置界面
- 打开 VSCode 设置（Cmd/Ctrl + ,）
- 搜索 "AI Comment"
- 配置以下设置：
  - ai-comment.apiProvider: AI 服务提供商（openai、anthropic 或 custom）
  - ai-comment.apiKey: API 密钥（必填）
  - ai-comment.apiBaseUrl: 自定义 API 基础 URL（可选，仅当 provider 为 custom 时使用）
  - ai-comment.model: 使用的模型（默认：gpt-3.5-turbo）
  - ai-comment.language: 注释语言（auto、en、zh）

未配置时的提示

如果未配置 API 密钥，当你尝试生成注释时，插件会：

显示友好的提示信息
提供"打开设置"按钮，一键跳转到配置页面
不会执行任何操作，避免产生错误

配置示例

使用 OpenAI（默认）

{
  "ai-comment.apiProvider": "openai",
  "ai-comment.apiKey": "sk-your-api-key-here",
  "ai-comment.model": "gpt-3.5-turbo",
  "ai-comment.language": "auto"
}

使用 Anthropic (Claude)

{
  "ai-comment.apiProvider": "anthropic",
  "ai-comment.apiKey": "sk-ant-your-api-key-here",
  "ai-comment.model": "claude-3-sonnet-20240229",
  "ai-comment.language": "auto"
}

使用自定义 API（如本地部署或代理）

{
  "ai-comment.apiProvider": "custom",
  "ai-comment.apiKey": "your-api-key-here",
  "ai-comment.apiBaseUrl": "https://your-custom-api.com/v1",
  "ai-comment.model": "gpt-3.5-turbo",
  "ai-comment.language": "auto"
}

API Base URL 说明

API Base URL 用于指定自定义的 API 服务地址，主要用于以下场景：

使用自定义 API 服务
- 当你使用自部署的 OpenAI 兼容 API 时
- 当你使用 API 代理服务时
- 当你使用其他兼容 OpenAI API 格式的服务时
设置方法
- 将 apiProvider 设置为 "custom"
- 在 apiBaseUrl 中填入完整的 API 基础 URL（包含协议和路径）
- 例如：https://api.example.com/v1 或 http://localhost:8080/v1
默认行为
- 当 apiProvider 为 "openai" 时，默认使用 https://api.openai.com/v1
- 当 apiProvider 为 "anthropic" 时，默认使用 https://api.anthropic.com/v1
- 当 apiProvider 为 "custom" 时，必须设置 apiBaseUrl
常见使用场景
- 本地部署的模型服务：http://localhost:8000/v1
- API 代理服务：https://proxy.example.com/v1
- 兼容 OpenAI 格式的其他服务：根据服务提供商的文档设置

获取 API 密钥

OpenAI: 访问 OpenAI API Keys 创建 API 密钥
Anthropic (Claude): 访问 Anthropic API Keys 创建 API 密钥

使用方法

为选中代码生成注释

选中要添加注释的代码
使用快捷键 Cmd+Shift+C (Mac) 或 Ctrl+Shift+C (Windows/Linux)
或者通过命令面板（Cmd/Ctrl + Shift + P）运行 "AI Comment: Generate Comment for Selection"

注意：如果未配置 API 密钥，会提示你进行配置。

为整个文件生成注释

打开要添加注释的文件
通过命令面板运行 "AI Comment: Generate Comments for Entire File"

注意：如果未配置 API 密钥，会提示你进行配置。

快速打开设置

通过命令面板运行 "AI Comment: Open Settings" 快速打开配置页面

支持的语言

C++ (cpp, c)
Python (python)
Lua (lua)
Java (java)
JavaScript (javascript, js)
TypeScript (typescript, ts)

开发

项目结构

ai-comment/
├── src/
│   ├── extension.ts          # 主入口文件
│   ├── aiService.ts          # AI 服务集成
│   ├── commentGenerator.ts   # 注释生成器
│   └── languageSupport.ts    # 语言支持
├── package.json              # 插件配置
├── tsconfig.json            # TypeScript 配置
└── README.md                # 说明文档

构建

npm install
npm run compile

调试

按 F5 打开新的扩展开发宿主窗口
在新窗口中测试插件功能

打包

npm install -g vsce
vsce package

发布

如果你想将插件发布到 VSCode 官方市场，请查看 PUBLISH.md 获取详细的发布指南。

许可证

MIT License - 详见 LICENSE 文件

贡献

欢迎提交 Issue 和 Pull Request！

更新日志

0.1.5

🔧 修复：改用 * 激活事件，确保扩展始终激活
🔧 修复：添加命令注册验证和错误处理
🔧 修复：改进激活机制，解决命令找不到的问题

0.1.4

🔧 修复：添加激活日志和调试信息，帮助排查命令找不到的问题
🔧 修复：改进扩展激活机制，使用 onStartupFinished 确保扩展正确激活

0.1.3

🔧 修复：改进扩展激活机制，使用 onStartupFinished 确保扩展正确激活
🔒 安全：移除敏感文件，修复安全问题
🔧 修复：修复扩展激活问题，解决命令找不到的错误
✨ 改进：优化 API Base URL 配置支持
✨ 改进：增强错误处理和用户提示
📚 新增：添加详细的使用文档和故障排除指南

0.1.1

初始修复版本（已废弃）

0.1.0

初始版本
支持 C++、Python、Lua、Java、JavaScript、TypeScript
支持 OpenAI 和 Anthropic API
支持中英文注释生成

Gordon AI Comment Generator

Gordon-Code-Commenter