WebStorm快捷键之快速生成JSDoc注释的完整教程

风浩君_7203

风浩君_7203

2026-06-26

928人浏览

原创

webstorm的jsdoc自动生成仅在函数声明正前方触发,光标需紧贴function或const fn =左侧;输入/**后按enter才补全@param/@returns,箭头函数、解构参数等需手动补全或用fix doc comment修复。

webstorm快捷键之快速生成jsdoc注释的完整教程

光标必须紧贴函数名左侧才能触发 /** + Enter

WebStorm 的 JSDoc 自动生成不是“ anywhere 输入 /** 都行”,它只在函数/类/方法声明语句的正前方生效。比如 function foo(a, b) 这一行,光标得放在 f 前面(即行首或紧贴 function 左侧),输入 /** 后按 Enter 才会补全 @param@returns

常见失败场景:

  • 光标在函数体内、空行、注释后——不触发
  • 箭头函数 const bar = (x) => {}——不识别为声明,需先转成 function 或用 Fix Doc Comment
  • 解构参数 ({ a, b }) 或 rest 参数 ...args——@param 行常为空或错写,得手动补 @param {Object} options 这类描述
  • 类方法中 this 不被当作参数——@this 标签必须手写

Fix Doc Comment 是补救漏注释的唯一可靠方式

当你已经写了部分代码、光标不在声明行前、或注释格式混乱时,Ctrl+Shift+AFix Doc Comment 是最稳的选择。它不依赖光标位置,而是向上扫描最近的函数/方法/字段声明,再智能合并已有注释。

它的实际行为:

  • 保留你已写的 @param x,只补缺失的参数项
  • 如果函数体里有 return 但没返回值,可能误加 @returns——得手动删
  • 不推导复杂类型,比如 @param {string | number} 或泛型 T,必须手写
  • 对 getter/setter、async 函数、重载签名支持有限,容易漏 @returns {Promise} 这类关键信息

Live Templates 自定义 method* 要改变量表达式才可用

默认模板里的 $functionName$ 在函数声明行前是空的,因为 WebStorm 认为它只在函数体内有效。想让它在声明处也生效,必须进 Edit variables 把表达式设为 methodName()

jm-jsjkxyjs02-pzl-803
jm-jsjkxyjs02-pzl-803

查询全球任意城市的实时天气和未来天气预报

下载

其他关键设置点:

  • 模板适用范围选 StatementsEverywhere in JavaScript,否则新建文件时 method* + Tab 不触发
  • @param 行不能动态适配参数个数——模板里写三行,函数只有两个参数,就得手动删掉一行
  • 别用 @file:JSDoc 规范不认这个 tag;标文件归属用 @module 或自然语言更稳妥
  • $USER$$DATE$$HOUR$:$MINUTE$ 可用,但 $TIME$ 在某些系统上不刷新

jsdoc 命令行生成 HTML 文档必须手动执行

WebStorm 本身不生成 HTML 文档,所有“点一下出网页”的期待都会落空。真正构建文档的是外部 jsdoc 工具,必须走命令行。

典型流程和易错点:

  • 全局安装:npm install -g jsdoc(或项目局部装:npm install jsdoc --save-dev
  • 执行:jsdoc src/**/*.js -d docs,其中 src/**/*.js 是源码路径,docs 是输出目录
  • 报错 Cannot find module 'jsdoc':说明没装,或装了但 shell 没识别到全局 bin 路径
  • 生成空白页或缺内容:多半是源码路径写错,或 JSDoc 注释语法有硬伤(比如 @param 缺类型、@returns 后没空格)
  • 想省事?把命令写进 package.jsonscripts 里:"doc": "jsdoc src/**/*.js -d docs",然后运行 npm run doc

真正容易被忽略的是:JSDoc 注释一旦生成,就参与类型推导和补全。如果 @param {string} 写成 string(漏了花括号),后续调用处的类型提示就会失效——比不写还误导人。

相关文章

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

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

下载

相关标签:

webstorm webstorm快捷键 js

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

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

3776

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1195

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1538

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

9243

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

840

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2224

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1429

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

3749

3

js生成随机数方法
js生成随机数方法

JavaScript生成随机数的方法,包括使用Math.random()方法生成指定范围内的随机整数、生成随机字符串和生成随机颜色。根据具体需求,可以选择适合的方法来生成随机数,以实现各种功能 。

2023.09.25

2075

5

热门下载

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

精品课程

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