VSCode快捷生成注释块_支持JSDoc风格的注释插件

秋丽同学_5892

秋丽同学_5892

2026-04-17

947人浏览

原创

VSCode原生/**回车仅支持简单函数签名,Document This插件可稳定生成跨语言注释。其触发需光标置于函数名正上方,快捷键Ctrl+Alt+D(Win/Linux)或Cmd+Alt+D(macOS),并注意配置includeDescription、dateformat和jsdocReturnType三项关键设置。

vscode快捷生成注释块_支持jsdoc风格的注释插件

VSCode 本身支持 /** 回车生成基础 JSDoc 模板,但仅限于简单函数签名识别;真正稳定、可定制、跨语言的注释块生成,必须依赖插件——Document This 是目前最轻量且准确率最高的选择,尤其对 TypeScript 和现代 JavaScript 项目。

为什么 /** 回车经常不生效或参数类型为空?

VSCode 原生行为只解析最简函数声明(如 function foo(a, b)),一旦出现解构参数、箭头函数、TS 类型标注缺失、或函数体在另一行,它就无法提取参数名和类型。常见表现是生成的 @param 后面只有空占位符,甚至漏掉整个字段。

  • 确认右下角语言模式是否为 JavaScript 或 TypeScript(不是 Plain Text 或 JSON)
  • 确保函数定义是“可静态分析”的:避免 const fn = ({ a }) => {} 这类解构形参,改用 function fn(obj) { const { a } = obj; }
  • TS 项目中,若未启用 compilerOptions.allowJs: true 或缺少 .d.ts,原生提示会退化为 JS 行为
  • Prettier 插件可能在保存时自动删掉空行或格式化注释结构,导致后续触发失败

Document This 的正确触发方式和默认快捷键

它不依赖输入 /**,而是直接定位到函数/类/变量声明行,用快捷键触发,因此更鲁棒。安装后无需重启,但首次使用建议重载窗口(Ctrl+Shift+P → Developer: Reload Window)。

JS X Monitor
JS X Monitor

X.com (Twitter) 账号监控自动化:定时抓取指定账号最新推文,发现新内容即时推送通知。

下载
  • 光标放在函数名正上方(不要在函数体内,也不要放在 export 或 async 关键字上)
  • 默认快捷键:Ctrl+Alt+D(Windows/Linux)或 Cmd+Alt+D(macOS);部分系统可能被输入法占用,可在键盘快捷方式中搜索 document this 修改
  • 也可通过命令面板:Ctrl+Shift+P → 输入 Document This: Document This 手动执行
  • 对箭头函数支持有限,建议优先用于 function 声明或 TS 中带明确返回类型的 const fn = (a: string): number =>

自定义模板时最容易忽略的三个配置项

打开设置(Ctrl+, ),搜索 document this,关键配置都在 documentthis. 前缀下。别只改 author,以下三项直接影响生成质量:

  • documentthis.includeDescription:设为 true 才会在每段注释开头加 @description 字段,否则默认跳过
  • documentthis.dateformat:值应为标准 moment.js 格式字符串,例如 "YYYY-MM-DD HH:mm:ss";填错会导致日期显示为 Invalid date
  • documentthis.jsdocReturnType:设为 true 才会尝试从函数体 return 语句推断返回类型(如 return "ok" → @returns {string}),但对复杂逻辑无效,慎开

真正难的是统一团队风格:比如强制要求每个 @param 后必须跟短横线(@param {string} name - 用户名),这需要修改插件源码或换用 JSDoc Annotation 这类支持正则模板的插件——但多数项目没必要走到那一步,先用好 Document This + ESLint 的 jsdoc/require-description 规则,已能覆盖 90% 场景。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3489

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2408

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1340

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1298

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2298

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3760

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17595

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程