159 lines
4.1 KiB
Markdown
159 lines
4.1 KiB
Markdown
# VSCode 中英文变量名翻译插件
|
||
|
||
一个智能的VSCode扩展插件，实现中英文文本与变量名的快速互译，支持多种命名规范。
|
||
|
||
## ✨ 功能特性
|
||
|
||
- **智能翻译**：支持中文→英文变量名，英文→中文的双向翻译
|
||
- **命名规范**：支持驼峰命名(camelCase)、帕斯卡命名(PascalCase)、下划线命名(snake_case)
|
||
- **多翻译引擎**：集成Google翻译和百度翻译双引擎
|
||
- **快捷操作**：支持快捷键和右键菜单，操作便捷
|
||
- **实时预览**：翻译结果实时显示，支持确认后替换
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 安装方式
|
||
|
||
1. **从VSCode扩展市场安装**（推荐）
|
||
- 打开VSCode扩展面板 (`Ctrl+Shift+X`)
|
||
- 搜索 "中英文变量名翻译"
|
||
- 点击安装
|
||
|
||
2. **手动安装**
|
||
- 下载 `.vsix` 文件
|
||
- 在VSCode中运行 `Extensions: Install from VSIX...`
|
||
|
||
### 使用方法
|
||
|
||
#### 翻译为英文变量名
|
||
- **快捷键**：选中中文文本，按 `Ctrl+Alt+E` (Mac: `Cmd+Alt+E`)
|
||
- **右键菜单**：选中中文文本 → 右键 → "翻译为英文变量名"
|
||
|
||
#### 翻译为中文
|
||
- **快捷键**：选中英文文本，按 `Ctrl+Alt+C` (Mac: `Cmd+Alt+C`)
|
||
- **右键菜单**：选中英文文本 → 右键 → "翻译为中文"
|
||
|
||
## ⚙️ 配置说明
|
||
|
||
### 设置路径
|
||
`文件 → 首选项 → 设置 → 扩展 → 中英文变量名翻译`
|
||
|
||
### 配置项
|
||
|
||
| 配置项 | 说明 | 默认值 | 可选值 |
|
||
|--------|------|--------|--------|
|
||
| `translate.namingConvention` | 变量命名规范 | `camelCase` | `camelCase`, `PascalCase`, `snake_case` |
|
||
| `translate.translationService` | 翻译服务提供商 | `google` | `google`, `baidu` |
|
||
| `translate.baiduAppId` | 百度翻译API的AppID | `""` | 你的百度AppID |
|
||
| `translate.baiduSecretKey` | 百度翻译API的密钥 | `""` | 你的百度密钥 |
|
||
|
||
### 百度翻译API配置
|
||
|
||
如需使用百度翻译，请：
|
||
1. 访问[百度翻译开放平台](https://fanyi-api.baidu.com/)
|
||
2. 注册账号并创建应用
|
||
3. 在插件设置中填写 `AppID` 和 `密钥`
|
||
|
||
## 🔧 开发指南
|
||
|
||
### 环境要求
|
||
- Node.js (>= 16.x)
|
||
- VSCode (>= 1.85.0)
|
||
- TypeScript
|
||
|
||
### 本地开发
|
||
|
||
```bash
|
||
# 克隆项目
|
||
git clone <repository-url>
|
||
|
||
# 安装依赖
|
||
npm install
|
||
|
||
# 编译TypeScript
|
||
npm run compile
|
||
|
||
# 进入开发模式（监听文件变化）
|
||
npm run watch
|
||
```
|
||
|
||
### 调试
|
||
|
||
1. 按 `F5` 启动Extension Development Host
|
||
2. 在新窗口中测试插件功能
|
||
3. 查看调试控制台输出
|
||
|
||
### 打包发布
|
||
|
||
```bash
|
||
# 编译生产版本
|
||
npm run vscode:prepublish
|
||
|
||
# 生成.vsix文件
|
||
npx vsce package
|
||
```
|
||
|
||
## 📁 项目结构
|
||
|
||
```
|
||
vscode-translate-plugin/
|
||
├── src/
|
||
│ ├── extension.ts # 主扩展入口
|
||
│ ├── translationService.ts # 翻译服务
|
||
│ └── namingFormatter.ts # 命名格式化
|
||
├── docs/
|
||
│ ├── design.md # 设计文档
|
||
│ ├── 开发指南.md # 开发指南
|
||
│ └── 用户指南.md # 用户指南
|
||
├── package.json # 扩展配置
|
||
└── tsconfig.json # TypeScript配置
|
||
```
|
||
|
||
## 🐛 常见问题
|
||
|
||
### Q: 翻译失败怎么办？
|
||
**A**:
|
||
1. 检查网络连接
|
||
2. 如果使用百度翻译，确认API配置正确
|
||
3. 尝试切换翻译服务提供商
|
||
|
||
### Q: 如何修改快捷键？
|
||
**A**:
|
||
`文件 → 首选项 → 键盘快捷方式` → 搜索 "translate" 修改对应命令的快捷键
|
||
|
||
### Q: 翻译结果不准确？
|
||
**A**:
|
||
- 建议使用百度翻译API（需配置密钥），中文翻译质量更好
|
||
- 可结合上下文调整原文表述
|
||
|
||
## 🤝 贡献指南
|
||
|
||
欢迎提交Issue和Pull Request！
|
||
|
||
### 开发规范
|
||
- 使用TypeScript编写
|
||
- 遵循ESLint代码规范
|
||
- 添加必要的注释和文档
|
||
- 确保功能测试通过
|
||
|
||
## 📄 许可证
|
||
|
||
MIT License - 详见 [LICENSE](LICENSE) 文件
|
||
|
||
## 📝 更新日志
|
||
|
||
### v0.0.1 (2024-07-21)
|
||
- ✨ 初始版本发布
|
||
- 🌟 支持中英文双向翻译
|
||
- 🌟 支持三种命名规范
|
||
- 🌟 集成Google和百度翻译API
|
||
- 🌟 支持快捷键和右键菜单操作
|
||
|
||
## 📞 联系方式
|
||
|
||
- 提交Issue：[Git Issues](http://10.0.0.99:4000/tian/TranslateCode/issues)
|
||
- 邮箱：tianjianyong@gmail.com
|
||
|
||
---
|
||
|
||
**享受编码，让翻译更简单！** 🎉 |