NARUTO JSDoc 助手
一个强大的 VSCode 扩展，用于快速生成 JSDoc 风格的代码注释。支持 TypeScript/JavaScript 代码的类、方法和属性注释生成，并提供丰富的自定义配置选项。
文档
功能特点
1. 快速注释生成
- 类注释生成 (Ctrl+Alt+C)：为类快速生成 JSDoc 注释
- 方法注释生成 (Ctrl+Alt+F)：为方法快速生成 JSDoc 注释
- 属性注释生成 (Ctrl+Alt+P)：为属性快速生成 JSDoc 注释
- AI 智能注释生成 (Ctrl+Alt+I)：使用 AI 技术智能生成注释
2. 个性化配置
- 自定义注释模板
- 作者信息设置
- 快捷键自定义
- AI 配置选项
- 实时预览功能
3. 配置管理
- 配置导入导出
- 团队配置共享
- 配置版本控制
- 元数据管理
系统要求
- VSCode 版本：1.50.0 及以上
- 推荐版本：1.70.0 及以上（推荐，提供最佳体验）
- 操作系统：Windows, macOS, Linux
安装说明
- 打开 VSCode
- 进入扩展市场 (Ctrl+Shift+X)
- 搜索 "NARUTO JSDoc"
- 点击安装按钮
- 安装完成后重启 VSCode
快速开始
基本使用
生成类注释：
- 将光标放在类定义处
- 按下
Ctrl+Alt+C (Mac: Cmd+Alt+C)
- 自动生成类注释模板
生成方法注释：
- 将光标放在方法定义处
- 按下
Ctrl+Alt+F (Mac: Cmd+Alt+F)
- 自动生成方法注释模板
生成属性注释：
- 将光标放在属性定义处
- 按下
Ctrl+Alt+P (Mac: Cmd+Alt+P)
- 自动生成属性注释模板
使用 AI 智能注释
- 选择要注释的代码
- 按下
Ctrl+Alt+I (Mac: Cmd+Alt+I)
- AI 将分析代码并生成智能注释
配置说明
1. 打开配置面板
- 点击 VSCode 左侧活动栏的 NARUTO JSDoc 图标
- 或使用命令面板 (Ctrl+Shift+P) 输入 "NARUTO JSDoc: 打开配置"
2. 自定义模板
在配置面板中，你可以自定义以下模板：
类注释模板：
/**
* {{className}} 类
* @class {{className}}
* @description {{description}}
* @author {{author}}
* @date {{date}}
*/
方法注释模板：
/**
* {{methodName}} - {{description}}
* @method {{methodName}}
* @param {{{paramType}}} {{paramName}} - {{paramDescription}}
* @returns {{{returnType}}} {{returnDescription}}
*/
属性注释模板：
/**
* {{propertyName}} - {{description}}
* @type {{{propertyType}}}
* @description {{description}}
*/
3. 配置导入导出
导出配置：
- 在配置面板中点击"导出配置"按钮
- 选择保存位置
- 配置文件将包含所有自定义设置
导入配置：
- 在配置面板中点击"导入配置"按钮
- 选择要导入的配置文件
- 配置将自动应用到当前环境
4. AI 配置
选择 AI 模型：
- 本地模型 (LMStudio)
- 在线模型 (需要配置 API Key)
设置详细程度：
配置 API 信息：
快捷键参考
| 功能 |
Windows/Linux |
macOS |
| 生成类注释 |
Ctrl+Alt+C |
Cmd+Alt+C |
| 生成方法注释 |
Ctrl+Alt+F |
Cmd+Alt+F |
| 生成属性注释 |
Ctrl+Alt+P |
Cmd+Alt+P |
| AI 智能注释 |
Ctrl+Alt+I |
Cmd+Alt+I |
常见问题
1. 注释生成不工作
- 确保光标位置正确
- 检查代码语法是否正确
- 确认快捷键未被其他扩展占用
2. AI 功能无法使用
- 检查网络连接
- 确认 API Key 配置正确
- 验证 LMStudio 是否正常运行
3. 配置导入失败
- 检查配置文件格式是否正确
- 确认配置文件版本兼容
- 查看错误提示信息
4. VSCode 版本兼容性问题
- 确保您使用的 VSCode 版本是 1.50.0 或更高版本
- 如果在旧版本 VSCode 中遇到问题，请尝试更新到最新版本
- 对于 WebView 显示问题，请确保使用 1.70.0 或更高版本
- 在老旧版本中，文件系统 API 可能不兼容，请使用 1.50.0 以上版本
技术支持
- 邮箱：support@naruto-jsdoc.com
- 工作时间：周一至周五 9:00-18:00
- 问题反馈：GitHub Issues
更新日志
v1.0.0
- 初始版本发布
- 支持基本注释生成功能
- 提供配置导入导出
- 集成 AI 智能注释
许可证
MIT License
贡献指南
欢迎提交 Pull Request 或报告问题。请确保：
- 代码符合项目规范
- 添加必要的测试
- 更新相关文档
致谢
感谢所有贡献者和用户的支持！
| |
