WebStorm 2025.2 Help

JSDoc 注释

WebStorm 能识别 JSDoc 注释 ,并在您键入块注释开头 /** 并按下 Enter 键时,自动插入 @param@returns@private 等标签,帮助您快速创建注释。 JSDoc 注释用于在 JavaScript 和 TypeScript 中通过 Ctrl+Q 查询文档,详见 JavaScript 文档查询TypeScript 文档查询 ,也用于 类型注解 以及链式方法的 方法返回类型提示

WebStorm 还可以识别文档注释中的 TODO 模式Closure Compiler 注解和 TypeScript 语法 ,并将其用于代码补全、意图操作和其他代码辅助功能中。

对于 JSDoc 语法及示例,详见 JSDoc 入门JSDoc 支持类型

创建 JSDoc 注释

  • 将插入符放在要添加文档的方法/函数或字段声明前,键入块注释开头 /** 并按下 Enter 键。

    WebStorm 会生成包含参数(@param )与返回值(@returns )列表的 JSDoc 注释(如适用)。 请描述所列出的参数、返回值等内容。

    生成 JSDoc 注释
  • 或者,使用专用的 修复文档注释 操作。 将插入符放在需添加文档的方法/函数或字段,按下 Ctrl+Shift+A 并开始键入 Fix Doc Comment。 然后从列表中选择 修复文档注释 ,并按下 Enter

JSDoc 注释中的 TypeScript 语法

您可以在 JavaScript 文件的 JSDoc 注释中使用 TypeScript 注解,例如 @type@typedef。 WebStorm 能识别 TypeScript 的语法结构,例如 联合类型@typedef 声明中的可选属性。

WebStorm 支持 TypeScript 注解的代码补全。

在 JavaScript 文件的 JSDoc 中补全 TypeScript 注解

WebStorm 会根据 @type 注解显示参数提示。

在 JavaScript 文件的 JSDoc 中根据类型注解显示参数提示

在编辑器中查看渲染后的 JSDoc 注释

使用 WebStorm 可将 JSDoc 注释以更易读的格式显示。 在此 渲染视图 模式中,内容将按照其 @ 标签分组显示,而标签本身则被省略。 您可以打开引用的网页,查看引用主题的快速文档,并调整字体大小以提升可读性。

JSDoc 注释的渲染视图
  • 要进入 渲染视图 模式,将鼠标悬停在注释上并点击边距中的 切换渲染视图图标 ,或按下 Ctrl+Alt+Q。 该图标将变为 切换渲染视图图标

    开启渲染视图模式
  • 要退出 渲染视图 模式,请点击边距中的 切换渲染视图图标 ,或在 JSDoc 注释的上下文菜单中选择 切换渲染视图 ,或按下 Ctrl+Alt+Q

    关闭渲染视图模式
  • 如需为当前文件中的所有 JSDoc 注释启用 渲染视图 模式,请在边距的上下文菜单中选择 呈现所有文档注释

    渲染当前文件中的所有注释
  • 如有需要,请在上下文菜单中选择 调整字体大小 并使用滑块调整字体大小。

    调整字体大小
  • 如需默认显示所有渲染后的 JSDoc 注释,请打开 设置 对话框(Ctrl+Alt+S ),转到 编辑器 | 常规 | 外观 ,并勾选 渲染文档注释 复选框。

    默认开启渲染后的 JSDoc 注释
  • 要隐藏渲染视图边距图标,请在边距的上下文菜单中选择 配置装订区域图标… ,然后在打开的 设置 | 编辑器 | 常规 | 标记图标 页面中取消选中 文档注释就地渲染 复选框。

最后修改日期: 2025年 9月 26日