146 lines
3.9 KiB
Markdown
146 lines
3.9 KiB
Markdown
# VSCode中英文变量名翻译插件 - 用户指南
|
||
|
||
- 作者：田建勇
|
||
- 邮件：tianjianyong@gmail.com
|
||
- 版本：0.0.1
|
||
- 时间：2025-7-20
|
||
|
||
## 简介
|
||
|
||
这是一个VSCode扩展插件，可以帮助您快速在中文和英文之间进行翻译，特别适用于编程时的变量命名。
|
||
|
||
主要功能：
|
||
- 将中文翻译为符合命名规范的英文变量名
|
||
- 将英文翻译为中文
|
||
- 支持多种命名规范：驼峰命名、帕斯卡命名、下划线命名
|
||
- 支持Google翻译和百度翻译服务
|
||
|
||
## 安装方法
|
||
|
||
### 方法1：通过VSIX文件安装（推荐）
|
||
|
||
1. **下载扩展包**
|
||
- 获取 `vscode-translate-plugin-0.0.1.vsix` 文件
|
||
|
||
2. **安装扩展**
|
||
- 打开VSCode
|
||
- 点击左侧扩展图标（或按 `Ctrl+Shift+X`）
|
||
- 点击右上角的"..."菜单（更多操作）
|
||
- 选择"从VSIX安装..."
|
||
- 选择下载的 `vscode-translate-plugin-0.0.1.vsix` 文件
|
||
- 安装完成后重启VSCode
|
||
|
||
### 方法2：命令行安装
|
||
|
||
如果您有VSIX文件，可以使用命令行安装：
|
||
```bash
|
||
code --install-extension vscode-translate-plugin-0.0.1.vsix
|
||
```
|
||
|
||
## 使用方法
|
||
|
||
### 基本使用
|
||
|
||
#### 中文转英文变量名
|
||
1. 在编辑器中选中要翻译的中文文本
|
||
2. 使用以下任一方法：
|
||
- **右键菜单**：右键 → "翻译为英文变量名"
|
||
- **快捷键**：`Ctrl+Alt+E`（Mac: `Cmd+Alt+E`）
|
||
3. 选中文本将被替换为格式化后的英文变量名
|
||
|
||
#### 英文转中文
|
||
1. 在编辑器中选中要翻译的英文文本
|
||
2. 使用以下任一方法：
|
||
- **右键菜单**：右键 → "翻译为中文"
|
||
- **快捷键**：`Ctrl+Alt+C`（Mac: `Cmd+Alt+C`）
|
||
3. 会弹窗显示翻译结果，可选择是否替换原文本
|
||
|
||
### 使用示例
|
||
|
||
#### 示例1：中文变量名翻译
|
||
```
|
||
// 选中"用户列表" → 翻译为英文变量名
|
||
temp -> userList
|
||
```
|
||
|
||
#### 示例2：英文翻译为中文
|
||
```
|
||
// 选中"userList" → 翻译为中文
|
||
userList -> 用户列表
|
||
```
|
||
|
||
## 配置设置
|
||
|
||
### 打开设置
|
||
1. 打开VSCode设置（`Ctrl+,` 或 `Cmd+,`）
|
||
2. 搜索"translate"
|
||
|
||
### 可配置项
|
||
|
||
#### 1. 变量命名规范
|
||
- **设置项**：`translate.namingConvention`
|
||
- **选项**：
|
||
- `camelCase`（默认）：驼峰命名，如 `userName`
|
||
- `PascalCase`：帕斯卡命名，如 `UserName`
|
||
- `snake_case`：下划线命名，如 `user_name`
|
||
|
||
#### 2. 翻译服务提供商
|
||
- **设置项**：`translate.translationService`
|
||
- **选项**：
|
||
- `google`（默认）：Google翻译
|
||
- `baidu`：百度翻译
|
||
|
||
#### 3. 百度翻译API配置（可选）
|
||
如果使用百度翻译服务，需要配置：
|
||
- **设置项**：`translate.baiduAppId`
|
||
- **设置项**：`translate.baiduSecretKey`
|
||
|
||
### 配置示例
|
||
```json
|
||
{
|
||
"translate.namingConvention": "camelCase",
|
||
"translate.translationService": "google"
|
||
}
|
||
```
|
||
|
||
## 常见问题
|
||
|
||
### Q: 右键菜单不显示翻译选项？
|
||
A: 确保已选中文本，且扩展已正确安装。尝试重启VSCode。
|
||
|
||
### Q: 快捷键不起作用？
|
||
A:
|
||
1. 检查是否已选中文本
|
||
2. 检查是否有快捷键冲突：文件 → 首选项 → 键盘快捷方式
|
||
3. 可以尝试重新设置快捷键
|
||
|
||
### Q: 翻译失败？
|
||
A:
|
||
1. 检查网络连接
|
||
2. 如果使用百度翻译，确保API密钥正确配置
|
||
3. 尝试切换翻译服务提供商
|
||
|
||
### Q: 如何卸载扩展？
|
||
A:
|
||
1. 打开扩展面板（Ctrl+Shift+X）
|
||
2. 找到"中英文变量名翻译"扩展
|
||
3. 点击"卸载"按钮
|
||
4. 重启VSCode
|
||
|
||
## 支持语言
|
||
|
||
- **源语言**：中文、英文
|
||
- **目标语言**：根据所选翻译服务支持的语言
|
||
|
||
## 注意事项
|
||
|
||
1. **网络要求**：需要网络连接才能使用翻译功能
|
||
2. **文本长度**：建议翻译较短的文本，长文本可能影响准确性
|
||
3. **API限制**：免费API可能有使用频率限制
|
||
4. **变量命名**：翻译结果会自动转换为合法的变量名格式
|
||
|
||
## 获取帮助
|
||
|
||
如果遇到问题或有建议，请查看下列信息，并联系作者：
|
||
- 检查扩展的详细说明和更新日志
|
||
- 查看VSCode的开发者控制台获取错误信息 |