WebStorm运行JSDoc自动生成开发文档的步骤
WebStorm仅生成JSDoc注释框架，不直接输出HTML文档。需通过jsdoc命令行工具将注释解析为静态网页。将光标置于函数声明行首，键入/**后按Enter即可自动补全参数注释。但对于箭头函数、解构参数等特殊写法，需要手动处理或修复。
很多人在用 WebStorm 写 JSDoc 注释时都会遇到同一个困惑：明明按照教程敲了 /** + Enter，也生成了注释框架，可怎么就是看不到网页版的 index.html 文档？其实这里有个关键认知需要先理清——WebStorm 本身只负责在代码里插入注释块，它并不直接输出静态网页文档。真正把注释变成漂亮 HTML 页面的，是外部命令行工具 jsdoc。所以，如果在 IDE 里点了一圈没看到网页，别急着怀疑操作，而是很可能漏掉了第二步。
WebStorm不生成HTML文档，只生成注释框架
这一点值得反复强调：WebStorm 的核心能力是帮你快速生成符合 JSDoc 规范的注释模板，比如自动补全 @param、@returns 这些字段。但它不会帮你跑一次构建，更不会自动输出 index.html。很多人以为在编辑界面里点个“生成文档”就能看到网页，实际上那个功能只是生成注释框架本身。真正把注释解析成独立网页的，还得靠 jsdoc 这个独立工具——它读取源码中的注释，然后输出成完整的静态站点。
光标放对位置才能触发 /** + Enter
这是日常开发中最容易翻车的地方。注意：光标必须紧贴函数/类/方法声明行的最左侧——比如 function calculate() 这一行的开头，光标放在 f 前面。输入 /** 然后立刻按 Enter，WebStorm 才会自动补全出 @param 和 @returns 的占位。如果光标偏了一个字符，往往就只生成一个空的 /** */ 块，啥都不自动填充。
- 箭头函数（比如
const fn = (a) => {}）不会被自动识别，需要先把箭头函数转成普通function形式，或者用Ctrl+Shift+A搜索Fix Doc Comment手动修复。 - 解构参数（例如
({ id, name })）和 rest 参数（...args）经常被漏掉，生成的@param行会缺失这些参数，只能手动补全类型和说明。 - 类方法中如果使用了
this，WebStorm 不会自动生成@this标签，同样需要手写。
jsdoc 命令行生成静态文档
安装好 jsdoc 之后，真正开始生成网页文档的是终端里的那条命令。这里有几个常见操作和坑：
- 全局安装：
npm install -g jsdoc；局部安装：npm install jsdoc --sa ve-dev。推荐局部安装，避免污染全局环境。 - 基本命令示例：
jsdoc src/**/*.js -d docs。其中src/**/*.js是源码路径（支持通配符），docs是输出目录名。 - 常见报错
Cannot find module 'jsdoc'：先确认是否在项目根目录下运行命令，或者检查node_modules/.bin是否已加入$PATH环境变量。 - 如果想换主题（比如
docdash）：先执行npm install docdash，然后在命令中加上参数-t node_modules/docdash即可切换。
Live Templates 自定义 method* 时容易翻车
想通过 method* + Tab 快速生成 JSDoc 注释模板？这个技巧很实用，但有两个关键设置必须调好，否则 $functionName$ 变量永远为空。
- 进入
Settings → Editor → Live Templates → Ja vaScript，新建一个模板，缩写填method*。 - 点击
Edit variables，把$functionName$的 Expression 改为methodName()——这一步是核心，默认值不生效。 - 适用范围要选
Statements或Everywhere in Ja vaScript，如果只选了Function declaration，那么箭头函数、方法表达式等都无法触发。 - 另外，
@param行不建议硬编码固定数量，因为当函数有多个参数时，固定占位符会导致需要手动删除多余的条目。更好的做法是用 Groovy 脚本动态生成参数列表。
最后别忘了：注释一旦生成，就会参与 TypeScript 或 IDE 的类型推导。比如 @param {string} 写成 string（缺了大括号），后续调用处的类型提示就会直接失效——这比不写注释还危险。所以细节上多花一分钟，能省下后面排查类型的几小时。
正软商城本月促销专区，汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动，提供限时折扣、特价授权和优惠购买信息，活动库存及价格以页面实时展示为准。
正软商城装机必备专区，精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件，帮助用户快速完成新电脑软件配置。
正软商城Windows软件专区，汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件，提供软件介绍、系统要求、正版授权及购买下载服务。
正软商城macOS软件专区，精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具，提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。
正软商城iOS软件专区，精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用，提供功能介绍、适用设备、系统要求和正版获取方式等信息。
正软商城AI软件专区，汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具，提供功能介绍、适用平台、收费方式及正版购买信息。
正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法，同时介绍常用PDF软件和工具的使用技巧。
赤友清理大师是一款为 Mac 设计的智能清理优化工具，可精准扫描垃圾、大文件、重复文件等，释放磁盘空间。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件，为私密数据添加多重保护。高频操作更强调就近处理，浏览、整理和跨目录移动文件时，来回切换和重复点击都会少很多。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
