GoLand 2025.2 Help

JSDoc 注释

GoLand 识别 JSDoc 注释 ,并在您输入块注释开头 /** 并按 Enter 时,自动插入 @param@returns@private 及其他标签,帮助您创建它们。 JSDoc 注释可与 JavaScript 和 TypeScript 中的 Ctrl+Q 搭配使用以查阅文档,详见 JavaScript 文档查阅TypeScript 文档查阅 ,也适用于链式方法中的 类型注解方法返回类型提示

GoLand 还可识别位于文档注释中的 TODO 模式Closure Compiler 注解以及 TypeScript 语法 ,并在代码补全、意图操作及其他类型的编码辅助功能中使用这些内容。

JSDoc 入门JSDoc 支持的类型 中可查看包含示例的 JSDoc 语法详细说明。

创建 JSDoc 注释

  • 将光标置于要添加注释的方法/函数或字段声明前,输入块注释开头 /** ,并按下 Enter

    如适用,GoLand 会生成包含参数列表(@param )和返回值(@returns )的 JSDoc 注释。 说明列出的参数、返回值等内容。

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

JSDoc 注释中的 TypeScript 语法

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

GoLand 为 TypeScript 注解提供代码补全。

在 JavaScript 文件中为 JSDoc 中的 TypeScript 注解提供代码补全

基于 @type 注解,GoLand 会显示参数提示。

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

在编辑器中查看呈现后的 JSDoc 注释

借助 GoLand,JSDoc 注释可以更易阅读的格式显示。 在此 呈现视图 模式中,内容会根据其 @ 标签分组显示,但标签本身不会显示。 您可以打开引用的网页,查看引用主题的快速文档,并调整字体大小以提升可读性。

JSDoc 注释的呈现视图
  • 如需进入 呈现视图 模式,请将鼠标悬停于注释上并点击外侧边栏中的 切换呈现视图图标 ,或按下 Ctrl+Alt+Q。 图标会变为 切换呈现视图图标

    启用呈现视图模式
  • 如需退出 呈现视图 模式,请点击外侧边栏中的 切换呈现视图图标 ,或通过 JSDoc 注释的上下文菜单中选择 切换渲染视图 ,或按下 Ctrl+Alt+Q

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

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

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

    默认启用 JSDoc 注释呈现
  • 如需隐藏呈现视图的侧边栏图标,请从侧边栏中的上下文菜单中选择 配置装订区域图标… ,然后在打开的 设置|Editor|General|Gutter Icons 页面中取消选中 文档注释就地渲染 复选框。

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