WebStorm快速生成自定义JSDoc注释模板流程

P粉328763957

P粉328763957

2026-08-02

603人浏览

原创

webstorm的/**+enter仅在函数声明行最左侧触发,光标须置于function关键字前;箭头函数需转换或手动补全,解构与rest参数、@this、@param类型均需手写,且类型必须用大括号包裹。

webstorm快速生成自定义jsdoc注释模板流程

光标位置不对,/** + Enter 就不生效

WebStorm 只在函数、类、方法声明行最左侧触发 JSDoc 自动补全。比如 function calculate(a, b) { 这一行,光标必须落在 f 前面(即行首),输入 /** 后立刻按 Enter 才能生成带 @param@returns 的框架。光标在行中、行尾、或声明行缩进后,都会失效。

箭头函数(如 const fn = (a) => {})默认不被识别,要么先转成 function 形式,要么用 Ctrl+Shift+AFix Doc Comment 手动补全。

  • 解构参数(({ id, name }))和 rest 参数(...args)不会自动生成 @param,必须手动补全类型和说明
  • 类方法里 this 不会自动加 @this,得手写
  • @param 类型必须用大括号包裹,比如 @param {string} name;写成 @param string name 会导致后续类型推导失效

Live Template 里 $functionName$ 总是空的

想用 method* + Tab 快速生成函数注释,关键在变量表达式设置。进入 Settings → Editor → Live Templates → JavaScript,新建模板后点 Edit variables,把 $functionName$ 的 Expression 改成 methodName(),否则它永远为空。

适用范围不能只选 Function declaration,得选 StatementsEverywhere in JavaScript,否则在对象方法、模块导出函数里无法触发。

  • 别硬写固定数量的 @param 占位符,多参数时删起来麻烦;可用 Groovy 脚本动态生成(但多数人直接手补更省事)
  • 模板里 @description 留空或写占位符,避免每次都要删

文件头注释和 JSDoc 注释是两套机制,别混用

新建 .js 文件时自动带作者/日期,走的是 File and Code Templates → Files → JavaScript File 路径,不是 Live Template。模板里必须用 ${USER}${YEAR}-${MONTH}-${DAY}${NAME} 这类变量,手写字符串(如 "zhangsan")不会替换。

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载

Live Template(比如输 cmt + Tab)只适合在已有文件里插函数说明、组件文档这类非强制内容,没法控制新建文件的首行。

  • 扩展名必须填 js,否则右键新建时看不到这个模板
  • 模板建在 IncludesCode 栏下无效,只对代码片段插入起作用
  • 如果要支持更新时间(@update),得配 File Watcher,Live Template 本身不感知文件修改

jsdoc 命令不报错但没输出 HTML

WebStorm 本身只生成注释文本,不生成 index.html。真正产出静态文档靠命令行工具 jsdoc,不是 IDE 内置功能。

常见卡点:执行 jsdoc src/**/*.js -d docsCannot find module 'jsdoc',大概率是因为没在项目根目录运行,或 node_modules/.bin 不在 $PATH 中。局部安装时建议用 npx jsdoc 避免路径问题。

  • 全局安装:npm install -g jsdoc;局部安装:npm install jsdoc --save-dev
  • 换主题(如 docdash):先 npm install docdash,再加参数 -t node_modules/docdash
  • 路径通配符注意 shell 差异,Windows 命令行可能需写成 src\**\*.js

注释一旦生成,就参与类型推导——类型写错比不写还危险,比如漏掉大括号、拼错类型名,会让调用处的提示直接消失。

相关文章

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

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

下载

相关标签:

js webstorm webstorm配置

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

相关专题

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

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

2023.06.20

1830

8

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

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

2023.07.28

888

5

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

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

2023.08.03

1153

5

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

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

2023.08.17

7862

11

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

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

2023.09.01

637

4

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

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

2023.09.04

1211

5

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

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

2023.09.14

1054

5

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

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

2023.09.21

1924

3

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

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

2023.09.25

939

5

热门下载

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

精品课程

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