JSDoc 注释
PyCharm 可识别 JSDoc 注释 ，并在您键入开头的块注释 /** 并按下 Enter 时，通过自动插入 @param、 @returns、 @private 以及其他标签来帮助您创建它们。 JSDoc 注释用于在 JavaScript 和 TypeScript 中通过 Ctrl+Q 进行文档查找，参见 JavaScript 文档查找 和 TypeScript 文档查找 ，以及在链式方法中用于 类型注解 和 方法返回类型提示。
PyCharm 还可识别文档注释中的 TODO 模式、 Closure Compiler 注解和 TypeScript 语法 ，并在代码补全、意图操作及其他类型的代码辅助中使用它们。
有关 JSDoc 语法的详细说明及示例，请参见 JSDoc 入门 和 JSDoc 支持的类型。
创建 JSDoc 注释
将插入符号置于要编写文档的方法、函数或字段的声明之前，键入块注释开头
/**，然后按 Enter。PyCharm 会生成一个 JSDoc 注释，其中包含参数列表（
@param）和返回值（@returns）（如适用）。 描述所列参数、返回值等。
或者，使用专用的 修复文档注释 操作。 将插入符号置于要编写文档的方法、函数或字段处，按下 Ctrl+Shift+A 并开始键入
Fix Doc Comment。 然后在列表中选择 修复文档注释 ，并按 Enter。
JSDoc 注释中的 TypeScript 语法
您可以在 JavaScript 文件中的 JSDoc 注释内使用 TypeScript 注解，例如 @type 或 @typedef。 PyCharm 可识别 TypeScript 语法结构，例如 联合类型 或 @typedef 声明中的可选属性。
PyCharm 为 TypeScript 注解提供代码补全。
基于 @type 注解，PyCharm 会显示参数提示。
在编辑器中查看渲染的 JSDoc 注释
使用 PyCharm，可以以更易读的格式显示 JSDoc 注释。 在此 渲染视图 模式下，条目将按其 @ 标签分组显示，而标签本身将被省略。 您可以打开引用的网页、查看引用主题的快速文档，并调整字体大小以获得更好的可读性。
要进入 渲染视图 模式，将鼠标悬停在注释上并点击标记栏中的
，或按 Ctrl+Alt+Q。 该图标将变为 
。
要退出 渲染视图 模式，请点击标记栏中的
，或在 JSDoc 注释的上下文菜单中选择 切换渲染视图 ，或按 Ctrl+Alt+Q。
要为当前文件中的所有 JSDoc 注释启用 渲染视图 模式，请在标记栏中的上下文菜单中选择 呈现所有文档注释。
如有需要，请在上下文菜单中选择 调整字体大小 ，并使用滑块更改字体大小。
要默认显示渲染的 JSDoc 注释，请打开 设置 对话框（Ctrl+Alt+S ），转到 ，并选中 渲染文档注释 复选框。
要隐藏渲染视图的标记栏图标，请在标记栏中的上下文菜单中选择 配置装订区域图标… ，然后在打开的 页面上清除 文档注释就地渲染 复选框。