comment-ai-helper/README.md

专业的多语言代码注释生成工具，支持11种编程语言，提供代码可读性评分和工程级注释生成

# AI Code Comment Generator [![npm version](https://img.shields.io/npm/v/comment-ai-helper.svg)](https://www.npmjs.com/package/comment-ai-helper)

专业的多语言代码注释生成工具，相比通用AI解决方案：
✅ 专注主流编程语言的工程级注释生成
✅ 提供CLI和API两种使用方式，命令行接口（CLI）和应用编程接口（API）均可使用，方便集成到现有开发流程中。
✅ 专为开发团队优化

## 功能特性
- 自动生成符合语言规范的注释（JSDoc/PEP 257等）
- 支持简洁和详细两种注释模式
- 命令行接口(CLI)和模块化API
- 基于正则匹配的可靠解析技术，支持JavaScript、Python、Java、C/C++和MySQL

## NPM 安装与使用

### 全局安装
```bash
npm install -g comment-ai-helper
comment-ai generate demo.js --language js
```

### 作为项目依赖安装
```bash
npm install comment-ai-helper --save-dev
```

### 编程式调用
```javascript
const { CommentGenerator } = require('comment-ai-helper');

// 初始化生成器
const generator = new CommentGenerator('your-api-key-here');

// 处理文件
generator.processFile('demo.js', 'your-api-key-here', {
  language: 'javascript',
  detailLevel: 'detailed'
}).then(() => {
  console.log('注释生成完成');
});
```

## 开发环境安装与使用

1. **克隆项目并安装依赖**
```bash
git clone <项目地址>
cd comment-ai-helper
npm install
npm run build
```

2. **设置API密钥**
```bash
# 通过环境变量（推荐）
export DEEPSEEK_API_KEY="your_api_key_here"

# 或通过配置文件
echo 'module.exports = { apiKey: "your_api_key_here" }' > config.js
```

3. **生成注释**
```bash
# 基本用法
node dist/src/cli.js generate <file> --language <lang> [--detailed]

# 示例：为Python文件生成详细注释
node dist/src/cli.js generate test.py --language py --detailed

# 示例：为JavaScript文件生成简洁注释
node dist/src/cli.js generate test.js --language js

# 示例：为MYSQL文件生成简洁注释
node dist/src/cli.js generate test.sql --language sql
```

4. **全局安装(可选)**
```bash
# 在项目根目录执行
npm install -g .

# 全局使用
comment-ai generate test.py --language py --detailed
```

## 支持的语言
- JavaScript (`--language js`)
- Python (`--language py`)
- Java (`--language java`)
- C (`--language c`)
- C++ (`--language cpp`)
- MySQL (`--language mysql`)

## 项目特点
- 精准匹配各语言规范，支持函数、类、方法等多种代码结构
- 轻量级高效实现，基于正则表达式的智能代码块识别
- 易于集成到开发流程中，提供CLI和API两种使用方式

## 常见问题解决

1. **如果遇到TypeScript编译错误**：
   ```bash
   npm run build
   ```

2. **如果遇到API密钥错误**：
   确保已设置DEEPSEEK_API_KEY环境变量或config.js配置文件

3. **如果遇到文件路径错误**：
   确保指定的文件路径正确且文件存在

## 注意事项
- 请妥善保管您的API密钥
- 生成的注释仅供参考，建议人工审核
- 不同语言的注释规范可能需要根据实际需求调整