WebStorm运行JSDoc自动生成开发文档的步骤

P粉328763957

P粉328763957

2026-06-17

285人浏览

原创

webstorm仅生成jsdoc注释框架而不生成html文档,真正生成index.html需通过命令行工具jsdoc执行;光标须置于函数声明行最左侧输入/**+enter才能自动补全,箭头函数需转换形式,解构与rest参数需手动补全@param,@this需手写,jsdoc命令需正确安装与路径配置,live templates中$functionname$需设为methodname(),@param类型必须用大括号包裹。

webstorm运行jsdoc自动生成开发文档的步骤

WebStorm不生成HTML文档,只生成注释框架

WebStorm 本身不会输出网页版文档,它只负责在代码里插入符合 JSDoc 规范的注释块。真正生成 index.html 的是外部命令行工具 jsdoc。如果在 WebStorm 里点几下没看到网页,不是操作错了,而是还没走完第二步。

光标放对位置才能触发 /** + Enter

这是最常用也最容易失败的环节:光标必须紧贴函数/类/方法声明行的最左侧(比如 function calculate() 这一行开头,光标在 f 前),输入 /** 后立刻按 Enter,WebStorm 才会自动补全 @param@returns

  • 箭头函数(const fn = (a) => {})不被识别,得先转成 function 形式,或用 Ctrl+Shift+AFix Doc Comment
  • 解构参数(如 ({ id, name }))和 rest 参数(...args)常被漏掉,@param 行需手动补全类型和说明
  • 类方法里的 this 不会自动生成 @this,必须手写

jsdoc 命令行生成静态文档

装好 jsdoc 后,在终端执行命令才是出网页的关键:

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

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

下载
  • 全局安装:npm install -g jsdoc;局部安装:npm install jsdoc --save-dev
  • 基本命令:jsdoc src/**/*.js -d docssrc/**/*.js 是源码路径,docs 是输出目录)
  • 常见报错 Cannot find module 'jsdoc':检查是否在项目根目录运行,或确认 node_modules/.bin 是否在 $PATH
  • 想换主题(比如 docdash):先 npm install docdash,再加参数 -t node_modules/docdash

Live Templates 自定义 method* 时容易翻车

想用 method* + Tab 快速生成,得调两个关键设置,否则 $functionName$ 总是空的:

  • Settings → Editor → Live Templates → JavaScript,新建模板,缩写填 method*
  • 点击 Edit variables,把 $functionName$ 的 Expression 改成 methodName()
  • 适用范围选 StatementsEverywhere in JavaScript,不能只选 Function declaration
  • @param 行别硬写固定数量,否则多参数时要手动删占位符;建议用 Groovy 脚本动态生成

注释一旦生成,就参与类型推导——@param {string} 写成 string(缺大括号),后续调用处的类型提示就会失效,比不写还危险。

相关文章

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

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

下载

相关标签:

js webstorm

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

相关专题

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

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

2023.06.20

1881

8

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

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

2023.07.28

912

5

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

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

2023.08.03

1155

5

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

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

2023.08.17

7910

11

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

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

2023.09.01

639

4

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

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

2023.09.04

1236

5

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

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

2023.09.14

1079

5

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

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

2023.09.21

2005

3

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

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

2023.09.25

985

5

热门下载

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

精品课程

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