WebStorm怎么生成JSDoc注释_WebStorm自动生成文档教程

轻涛君_5735

轻涛君_5735

2026-05-05

522人浏览

原创

WebStorm仅生成JSDoc注释,jsdoc命令行工具生成HTML文档;需正确使用/**+Enter、自定义Live Templates、File Templates及严格遵循JSDoc语法。

webstorm怎么生成jsdoc注释_webstorm自动生成文档教程

WebStorm 本身不生成最终的 HTML 文档,它只负责生成符合 JSDoc 规范的代码注释;真正生成可浏览文档的是外部工具 jsdoc 命令行程序。搞混这点,后续所有操作都会卡在“为什么点几下没出网页?”上。

在函数/方法前按 /** + Enter 自动生成 JSDoc 框架

这是最常用、也最可靠的注释生成方式,依赖 WebStorm 对 JS/TS 语法的实时解析:

  • 光标必须放在函数声明行的正前方(不能在函数体内,也不能在空行)
  • 输入 /** 后立刻按 Enter,WebStorm 会自动补全 @param 和 @returns(如果函数有返回值)
  • 若函数参数是解构对象或 rest 参数(如 ...args),WebStorm 可能漏掉或写错类型,需手动补 @param {Object} options 这类描述
  • 类方法中,this 不会被识别为参数,@this 标签得自己加

用 Live Templates 自定义快捷生成(比如输入 method* + Tab)

默认模板只支持基础结构,要让它真正好用,得手动改变量逻辑:

  • 进 Settings → Editor → Live Templates → JavaScript,点 + 新建模板
  • 缩写填 method*,模板正文用 $functionName$ 而不是硬写文字——但注意:$functionName$ 只在函数内部生效,所以模板必须设为 “Applicable in: Statements” 或 “Everywhere in JavaScript”
  • 点击 Edit variables,把 $functionName$ 的 Expression 设为 methodName(),否则它永远为空
  • @param 行建议用 Groovy 脚本动态生成,否则每次都要手动删多出来的占位行

用 File and Code Templates 统一文件头注释

新建 .js 文件时自动生成作者、日期等信息,和 JSDoc 注释是两套机制,但能避免重复劳动:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 路径:Settings → Editor → File and Code Templates → Files → JavaScript File
  • 模板里可用变量:${USER}、${DATE}、${NAME}(当前文件名),但 ${TIME} 在某些系统上不刷新,建议用 ${HOUR}:${MINUTE}
  • 别写 @file,JSDoc 规范里没有这个 tag;想标记文件归属,用 @module 或直接写自然语言描述
  • 如果团队要求包含版本号或 license,这里加最稳妥,因为每次新建都强制带上

运行 jsdoc 命令生成静态 HTML 文档

WebStorm 不内置文档构建能力,这步必须靠命令行完成,且容易因路径或配置失败:

  • 先全局安装:npm install -g jsdoc(或项目局部装:npm install jsdoc --save-dev)
  • 终端执行:jsdoc src/**/*.js -d docs,其中 src/**/*.js 是源码路径,docs 是输出目录
  • 常见报错 Cannot find module 'jsdoc':检查是否在正确目录下运行,或用 npx:npx jsdoc src/index.js -d docs
  • 想支持 ES6+ 语法,需额外加 -c jsdoc.json 配置文件,并启用 plugins: ["plugins/markdown"] 等

最常被忽略的一点:JSDoc 注释里的类型写法(如 {string|number})必须严格遵循 JSDoc 官方语法,WebStorm 的类型提示用的是 TS/JSDoc 混合规则,但 jsdoc CLI 工具只认纯 JSDoc,写错一个括号就可能导致整个参数块失效。

相关文章

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

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

下载

相关标签:

js webstorm webstorm教程

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

相关专题

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

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

2023.06.20

3409

3

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

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

2023.07.25

2388

9

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

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

2023.08.02

1320

5

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

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

2023.08.09

1258

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

2278

7

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

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

2023.09.20

3700

8

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

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

2023.09.22

17135

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习