Prompt-Helper
这是一个用于快速生成 JSDoc 风格注释的 VS Code 插件。用于常见的前端结构化注释，便于触发 copilot。
特性
- 快速生成提示词注释的代码片段，适用于
vue、react、js、ts等多个开发场景。
安装
在 VS Code 中搜索Prompt-Helper并安装。
使用
在您的代码中输入提示词，然后按下Tab键即可生成注释。
目前已经支持的代码片段有：
@fn-* 方法类代码片段
输入 @fn- 后快速选择对应片段，可实现方法体的 JSDoc 风格注释
| Prefix |
Description |
@fn-normal→ |
常见的方法注释，适用于zero-shot式提示 |
@fn-steps→ |
步骤方法注释，适用于few-shot式注释需要分步骤描述 |
@fn-api→ |
接口方法，适用于api接口注释 |
@fn-enum→ |
枚举注释，适用于枚举定义 |
@fn-param→ |
定义参数，适用于在方法注释中新增参数 |
@fn-step→ |
定义步骤，适用于步骤注释中新增步骤 |
@vue-* vue 框架代码片段
输入 @vue- 后快速选择对应片段，可实现 vue 常用的代码片段注释
| Prefix | Description |
| ------------: | -------------------------------------------------- |
| @vue-prop→ | 快速定义vue的props |
| @vue3-watch→ | 快速定义可提示的vue3 watch函数 |
| @vue3-computed→ | 快速定义可提示的vue3 computed变量 |
| @vue3-ref→ | 快速定义可提示的vue3 ref变量 |
@react-* react 框架代码片段
输入 @react- 后快速选择对应片段，可实现 react 常用的代码片段注释
| Prefix | Description |
| ------------: | -------------------------------------------------- |
| @react-uef | 快速定义可提示的react副作用钩子 |
| @react-ust | 快速定义可提示的react状态钩子 |
输入 @tool- 后快速选择对应片段，可套用常用的 prompt 提示框架
| Prefix | Description |
| ------------: | -------------------------------------------------- |
| @tool-r*a→ | 快速生成Re-Act提问框架 |
| @tool-f*s→ | 快速生成few-shot提问框架 |
| @tool-timelog-js→ | 快速在js/ts生成时间记录注释 |
| @tool-timelog-html→ | 快速在html生成时间记录注释 |
| @anregion→ | 块级注释 |
贡献
欢迎贡献代码、报告问题或提出新功能的建议。
许可证
本软件使用MIT 许可证发布。
| |
