📖 GoodName 智能编程命名使用教程

掌握AI智能命名翻译的核心技巧,提升编程效率,规范代码质量

🚀 基础使用入门

输入中文描述:
用户管理模块
获取用户列表数据
删除用户信息记录
验证用户登录状态
智能英文命名:
userManagement
getUserListData
deleteUserInfoRecord
validateUserLoginStatus
1选择要翻译的文本

在代码编辑器中选中需要翻译的中文文本或描述。如果未选中任何文本,插件会弹出输入框供您输入。

支持单行、多行文本选择,也支持包含中英文混合的文本处理。

2使用快捷键或菜单翻译

按下 Ctrl + Alt + Shift + 1 (Mac: Cmd + Alt + Shift + 1) 快捷键进行翻译。

也可以右键选中文本,在弹出菜单中选择"GoodName翻译"选项。

3选择编程命名格式

在弹出的格式选择框中选择所需的命名格式,如驼峰命名、蛇形命名、帕斯卡命名等。

系统会根据上下文智能推荐最适合的命名格式。

4应用翻译结果

确认选择后,原文本将被自动替换为翻译结果,并显示成功通知。

支持撤销操作(Ctrl+Z),如果对结果不满意可以随时回退。

🎨 支持的编程命名格式详解

驼峰命名 (camelCase)

首字母小写,后续单词首字母大写,无分隔符

用户管理 → userManagement
获取数据列表 → getDataList
更新用户信息 → updateUserInfo

适用场景:JavaScript、Java、C#等语言的变量名、方法名、属性名

蛇形命名 (snake_case)

全小写字母,单词间用下划线连接

用户管理 → user_management
获取数据列表 → get_data_list
更新用户信息 → update_user_info

适用场景:Python变量名、函数名,数据库表名、字段名,配置文件键名

帕斯卡命名 (PascalCase)

所有单词首字母都大写,无分隔符

用户管理 → UserManagement
获取数据列表 → GetDataList
更新用户信息 → UpdateUserInfo

适用场景:类名、接口名、结构体名、命名空间、组件名

常量命名 (CONSTANT_CASE)

全大写字母,单词间用下划线连接

最大长度限制 → MAX_LENGTH_LIMIT
默认配置选项 → DEFAULT_CONFIG_OPTION
系统错误代码 → SYSTEM_ERROR_CODE

适用场景:常量定义、枚举值、环境变量、宏定义

短横线命名 (kebab-case)

全小写字母,单词间用短横线连接

用户管理 → user-management
获取数据列表 → get-data-list
更新用户信息 → update-user-info

适用场景:CSS类名、HTML属性、URL路径、文件名、包名

点分命名 (dot.case)

全小写字母,单词间用点号连接

用户管理 → user.management
获取数据列表 → get.data.list
更新用户信息 → update.user.info

适用场景:配置文件键名、包路径、命名空间层次结构

🤖 翻译模式对比与选择指南

对比维度 AI智能翻译 本地离线翻译
翻译准确度 ⭐⭐⭐⭐⭐ 基于大模型,理解上下文 ⭐⭐⭐ 基于规则,适用简单场景
上下文理解 ✅ 智能理解语义和编程上下文 ❌ 简单词汇对应,无语义理解
网络依赖 ❌ 需要稳定的网络连接 ✅ 完全离线运行,无网络要求
响应速度 ⭐⭐⭐ 取决于网络和API响应 ⭐⭐⭐⭐⭐ 毫秒级响应
配置复杂度 ⭐⭐ 需配置API密钥和模型 ⭐⭐⭐⭐⭐ 开箱即用,无需配置
使用成本 ⭐⭐⭐⭐ 支持免费模型,成本较低 ⭐⭐⭐⭐⭐ 完全免费
适用场景 专业编程、复杂语境、团队协作 简单翻译、离线环境、个人使用
💡 选择建议和最佳实践

推荐AI翻译:如果有稳定网络连接且注重翻译质量,建议使用AI翻译获得更专业的命名效果。

推荐本地翻译:如果经常在离线环境工作,或对数据隐私有特殊要求,本地翻译是理想选择。

混合使用:可以根据不同场景灵活切换,重要项目使用AI翻译,日常开发使用本地翻译。

⚙️ 高级功能与使用技巧

1批量翻译与文本处理

选择多行文本进行批量翻译,每行将独立处理并转换为对应的命名格式。

支持混合文本处理:包含中英文的文本会智能识别需要翻译的部分。

# 选中以下多行文本进行批量翻译 用户管理模块 获取用户列表接口 删除用户信息方法 更新用户数据功能 验证用户权限逻辑 # AI翻译结果(驼峰命名) userManagementModule getUserListInterface deleteUserInfoMethod updateUserDataFunction validateUserPermissionLogic
2智能上下文分析

AI翻译会根据代码上下文、文件类型、编程语言提供更准确和合适的翻译结果。

// 在数据库操作上下文中 查询用户 → queryUser / findUser / selectUser // 在UI组件上下文中 用户按钮 → userButton / UserButton // 在API接口上下文中 用户服务 → userService / UserService
3自定义AI模型配置

可以配置不同的AI模型以获得不同风格和准确度的翻译结果。

🆓 免费AI模型推荐

Qwen/Qwen2.5-7B-Instruct:阿里云免费模型,编程场景优化

API地址:https://api.siliconflow.cn/v1/chat/completions

特点:理解编程语境,支持中文,命名风格现代化

4快捷菜单与工作流集成

右键选中文本可直接访问翻译菜单,无需记忆复杂快捷键。

与IDE工作流无缝集成,支持代码重构、变量重命名等场景。

编程命名最佳实践

1语言特定命名规范

根据不同编程语言选择合适的命名格式和风格:

  • Java/JavaScript/TypeScript:变量、方法用camelCase,类名用PascalCase
  • Python:统一使用snake_case,类名使用PascalCase
  • C#/.NET:公共成员用PascalCase,私有字段用camelCase或_camelCase
  • CSS/HTML:类名、ID使用kebab-case
  • 数据库:表名、字段名使用snake_case
  • 常量/枚举:所有语言统一使用CONSTANT_CASE
2提升翻译质量的技巧

提供清晰、具体的中文描述可以获得更准确的翻译结果:

✅ 推荐的描述方式: 获取用户详细信息 → getUserDetailInfo 验证用户登录状态 → validateUserLoginStatus 处理文件上传请求 → handleFileUploadRequest ❌ 避免的模糊描述: 用户信息 → userInfo (过于简单) 处理数据 → processData (缺乏具体性) 验证用户 → validateUser (不够明确)
3团队协作与代码规范

在团队开发中保持命名一致性和规范性:

  • 制定并遵循团队统一的命名规范和格式
  • 建立项目专用的命名词汇表和术语库
  • 定期进行代码review,检查命名规范的执行
  • 使用GoodName统一翻译风格,避免个人差异
  • 文档化重要的命名决策和约定
4代码可读性与维护性

良好的命名是代码质量的重要指标:

  • 优先选择描述性强、意图明确的命名
  • 避免使用缩写和不常见的简写形式
  • 保持命名的一致性和可预测性
  • 考虑命名的国际化和本地化需求
  • 定期重构和优化命名,提升代码质量
⚠️ 使用注意事项

• 翻译结果仅供参考,建议结合实际业务场景和代码上下文进行调整

• 对于专业术语和业务特定词汇,可能需要手动优化翻译结果

• 重要的生产代码建议在翻译后进行团队review

• 注意检查翻译结果是否符合项目的命名约定和风格指南

使用过程中的常见问题

Q: 翻译结果不准确或不符合预期怎么办?

A: 可以尝试以下优化方法:

  • 切换到AI翻译模式获得更好的语义理解效果
  • 提供更详细和清晰的中文描述,包含更多上下文信息
  • 避免使用过于口语化或含糊不清的表达
  • 手动调整翻译结果以符合项目特定的命名规范
  • 建立项目词汇表,统一特定术语的翻译方式
Q: 如何处理专业术语和业务特定词汇?

A: 对于专业术语的处理建议:

  • 建立团队共享的术语词典,统一专业词汇的翻译
  • 在描述中提供更多上下文,帮助AI理解专业含义
  • 对于行业特定术语,可以先翻译通用部分,再手动调整专业术语
  • 使用现有的行业标准命名,保持与业界一致
Q: 支持哪些编程语言和开发场景?

A: GoodName是语言无关的命名工具,支持所有编程语言:

  • 前端开发:JavaScript、TypeScript、Vue、React、Angular
  • 后端开发:Java、Python、C#、PHP、Go、Node.js
  • 移动开发:Swift、Kotlin、Flutter、React Native
  • 数据库:MySQL、PostgreSQL、MongoDB等
  • 配置文件:JSON、YAML、XML、Properties等
🏠 返回首页 📖 安装指南 ❓ 常见问题 🔄 更新记录