phpstorm如何配置JSDoc自动生成注释(文档规范)

雨墨姑娘_8486

雨墨姑娘_8486

2026-05-14

688人浏览

原创

phpstorm仅生成jsdoc注释,文档由jsdoc工具生成;光标须置于函数/类声明行最左侧触发自动生成;箭头函数、解构参数等不支持自动补全;需手动配置live templates并修正变量表达式;文件头注释与jsdoc无关,应通过file and code templates配置;jsdoc仅为元数据,不提供类型安全。

phpstorm如何配置jsdoc自动生成注释(文档规范)

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

光标必须放在函数/类声明正前方才能触发

不是在函数体内、不是在空行、也不是在 function 后面——必须紧贴在声明行最左侧(例如 function calculate 这一行开头,光标在 f 前)。此时输入 /** 再按 Enter,才会激活 JSDoc 框架生成;否则只会插入普通多行注释。

  • 类方法同理:光标需放在 public / static 等修饰符前,或直接放在 function 关键字前
  • 箭头函数、const fn = () => {} 形式不支持自动生成,PhpStorm 不识别为可文档化函数
  • 解构参数(如 { id, name })或 rest 参数(...args)常被漏掉,@param 行需手动补全类型和描述
  • this 不会被自动识别为上下文对象,@this 标签必须手写

改 Live Templates 让 /** + Enter 真正好用

默认模板太简陋,连基础 @param 都可能为空。要让它适配真实项目,得进 Settings → Editor → Live Templates → JavaScript 手动编辑:

chartjs-reporter
chartjs-reporter

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

下载
  • 新建模板缩写建议设为 jsdoc,适用范围选 Everywhere in JavaScript
  • 变量 $FUNCTION_NAME$ 默认不生效,必须点 Edit variables,把表达式设为 methodName()
  • @param 行别硬写占位符,用 Groovy 脚本动态提取:groovyScript("return _1?.collect { it.split(' ')[-1] }.join(', ') ", methodParameters())
  • 返回值判断要谨慎:@returns 行建议勾选 Skip if the field is empty,避免无返回时仍生成空行

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

文件头(作者、日期、描述)走的是 File and Code Templates,和函数级 JSDoc 注释无关。配置路径是:Settings → Editor → File and Code Templates → Files → JavaScript File:

  • 可用变量:${USER}、${NAME}、${YEAR}-${MONTH}-${DAY}、${HOUR}:${MINUTE}(别用 ${TIME},某些系统不刷新)
  • 不要写 @file —— JSDoc 规范里没有这个 tag;想标归属,用 @module my-app 或自然语言描述更稳妥
  • 团队要求加 license 或版本号?在这里统一加,新建文件时自动带上,比每次手敲可靠

最易被忽略的一点:JSDoc 注释只是“元数据”,它本身不执行、不校验、不保证类型安全。你写了 @param {number} id,但传个字符串进去,运行时照样崩——它只为 IDE 提示、文档生成和静态分析服务。别指望靠注释挡住错误,该加 TypeScript 类型的地方,一个都不能少。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

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

下载

相关标签:

php phpstorm js

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

相关专题

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

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

2023.06.20

3349

3

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

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

2023.07.25

2368

9

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

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

2023.08.02

1300

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

1376

5

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

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

2023.09.20

2258

7

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

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

2023.09.20

3640

8

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

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

2023.09.22

16835

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习