讲师中心 微信公众号
AI工具推荐 视频效率加速

VSCode怎么使用JSDoc自动为JavaScript函数生成带参数说明注释

云墨大大_4643

云墨大大_4643

发布时间:2026-05-04 14:13:46

|

850人浏览过

|

来源于php中文网

原创

VSCode原生/**回车常只生成空框架,因其仅对简单function声明做静态分析;解构参数、箭头函数、TS类型缺失或函数体换行均导致参数名和类型提取失败。

vscode怎么使用jsdoc自动为javascript函数生成带参数说明注释

VSCode原生/**回车为什么经常只生成空框架?

因为VSCode默认只对简单函数声明(function add(a, b))做静态分析,一旦遇到解构参数、箭头函数、TS类型缺失或函数体换行,它就无法提取参数名和类型。常见表现是生成的@param后面只有{*}或空占位符,甚至漏掉整个字段。

必须满足三个前提才能触发有效填充:

  • 右下角语言模式必须是JavaScript或TypeScript(不是Plain Text)
  • 函数定义得“可静态分析”:优先用function fn(a, b) {},避免const fn = ({id}) => {}
  • 项目根目录有jsconfig.json且含"checkJs": true,否则语言服务退化

Document This插件怎么用才不生成错参数?

它不依赖输入/**,而是靠光标位置+快捷键触发,因此更鲁棒,但触发条件很具体:

  • 光标必须放在函数名正上方的空行,或直接在function isValid这一行任意位置(不能在export或async关键字上)
  • 默认快捷键:Ctrl+Alt+D(Windows/Linux)或Cmd+Alt+D(macOS),部分系统被输入法占用需重映射
  • 对箭头函数支持差,建议只用于function声明或带明确返回类型的const fn = (a: string): number =>

关键配置项(在设置里搜document this):

立即学习“Java免费学习笔记(深入)”;

  • documentthis.includeDescription:设为true才加@description
  • documentthis.jsdocReturnType:设为true才尝试从return语句推断返回类型
  • documentthis.dateformat:填"YYYY-MM-DD"这类标准格式,填错会显示Invalid date

参数类型写错会导致悬停提示失效

VSCode不校验类型拼写,但会按你写的文本去匹配已知类型。写成numberr或Stirng,提示就断了;写成{*}或空,连基本补全都变弱。

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载

推荐写法:

  • 基础类型用小写:{string}、{number}、{boolean}
  • 数组/对象写具体:{Array<string>}、{User[]}、{{ id: number; name: string }}
  • Promise写全:{Promise<string>},否则.then()参数没提示
  • 第三方库用import()语法:{import('axios').AxiosInstance}

注释和函数之间有空行,VSCode就当它不存在

这是最常被忽略的硬性规则:JSDoc注释必须紧贴函数声明上方,中间不能有任何空行。哪怕只多一个换行,VSCode的悬停提示、Document This的参数识别、jsdoc CLI的文档导出,全部失效。

错误示例:

/**
 * @param {string} name
 */
<p>function greet(name) { }

正确写法:

/**
 * @param {string} name
 */
function greet(name) { }

这个细节导致大量团队文档生成失败——不是工具不行,是注释位置错了。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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

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

3209

2023.06.20

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

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

2328

2023.07.25

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

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

1260

2023.08.02

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

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

1218

2023.08.09

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

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

1356

2023.09.05

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

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

2198

2023.09.20

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

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

3500

2023.09.20

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

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

15995

2023.09.22

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn