Skip to content

Emoji 注释增强器（emoji-comment-helper）

自动在注释中识别关键词并插入语义化 Emoji，增强代码的可读性与可搜索性。

✨ 特性

🐛 自动在注释中插入对应 Emoji
⚡ 实时检测，无需手动触发
⚠️ 仅作用于注释行，非侵入式
🔍 提升团队代码可读性与搜索效率

🚀 使用示例

在 .js 或 .ts 文件中输入注释：

// 修复分页异常
// 新增上传功能
// 注意参数顺序

自动变为：

// 🐛 修复分页异常
// ✨ 新增上传功能
// ⚠️ 注意参数顺序

📦 安装方式

本地调试

npm install
npm run compile

按 F5 启动调试环境，在新打开的宿主窗口中使用插件。

安装 `.vsix` 包

code --install-extension emoji-comment-helper-0.0.1.vsix

🔧 支持关键词

Emoji	匹配关键词
✨	新增、添加、引入
🐛	修复、bug、异常
⚠️	注意、小心、警告
🚧	TODO、待实现
🔒	权限、安全、敏感
💄	样式、UI、美化
⚡	优化、性能、缓存
♻️	重构、清理
📦	工具、封装、公用
🧪	调试、打印、测试
🤔	原因、特殊逻辑
📝	注释、文档、说明

🧠 使用建议

快速搜索：在 VSCode 搜索框中输入 🐛 即可快速定位所有 bug 修复位置
团队协作：统一注释语义标记，减少沟通成本
不建议用于多行注释块（/* ... */）

📌 TODO（未来版本）

[ ] 用户自定义关键词与 Emoji 配置
[ ] 支持右键菜单与命令栏手动插入
[ ] 多语言注释样式支持（Python、HTML 等）

🛠️ 开发者

Made with ❤️ by 月亮有石头

欢迎 PR 和建议！