JSDoc 评论
最后修改时间:2023年10月11日所需插件:
Javascript and TypeScript
- 该插件仅在 IntelliJ IDEA Ultimate 中可用,默认情况下启用。
IntelliJ IDEA 可以识别JSDoc 注释,并在您输入入门注释时自动插入@param
、@returns
、等标签来帮助您创建注释。JSDoc 用于注释JavaScript 和 TypeScript 中的文档查找,请参阅JavaScript 文档查找和TypeScript文档查找,以及链式方法中的类型注释和方法返回类型提示。@private
/**
EnterCtrl0Q
IntelliJ IDEA 还可以识别文档注释中的TODO 模式、闭包编译器注释和TypeScript 语法,将它们用于代码完成、解释操作和其他类型的编码辅助。
在JSDoc入门和JSDoc支持的类型中查找JSDoc语法的详细说明和示例。
创建 JSDoc 注释
将插入符号放在要记录的方法/函数或字段的声明之前,输入起始项注释
/**
,然后按。EnterIntelliJ IDEA 生成一个 JSDoc 注释,其中包含参数列表 (
@param
) 和返回值 (@returns
)(如果适用)。描述列出的参数、返回值等。提示
要关闭自动生成JSDoc注释,请打开“设置”对话框( ),转至编辑器|一般|智能键,然后清除输入区域中的插入文档注释存根模板。CtrlAlt0S
或者,使用专用的修复文档注释操作。将插入符号放在记录要记录的方法/函数或字段处,按并开始键入。然后从列表中选择修复文档注释CtrlShift0A
Fix Doc Comment
Enter,然后按。
JSDoc 注释中的 TypeScript 语法
您可以在 JavaScript 文件的 JSDoc 注释中使用 TypeScript 注释,例如@type
或。@typedef
IntelliJ IDEA 识别 TypeScript 语法构造,例如声明中的联合类型或可选属性@typedef
。
IntelliJ IDEA 为 TypeScript 注释提供了完整的代码。
IntelliJ IDEA@type
注释基于显示参数提示。
笔记
还支持混合类型。但是,当 JSDoc 和 TypeScript 语法时,IntelliJ IDEA 使用 JSDoc 语法。
查看编辑器中提交的 JSDoc 注释
借助 IntelliJ IDEA,JSDoc 注释可以以更容易阅读的格式显示。在此渲染视图模式下,项目按标签分组显示@
,而标签本身会被跳过。您可以打开引用的网页、查看引用主题的快速文档以及调整字体大小更具有独特性。
提示
渲染视图模式在 JavaScript 和 TypeScript 中均可用。
要进入渲染视图模式,此时鼠标停止在评论上并单击安装订线或按。图标变成。CtrlAlt0Q
要退出渲染视图模式,请单击安装修改线,或从 JSDoc 注释的上下文菜单中选择切换渲染视图CtrlAlt0Q,或按。
要为当前文件中的所有JSDoc注释打开“渲染视图”模式,请从安装订单线的上下文菜单中选择“渲染所有注释文档”。
如果需要,从上下文菜单中选择调整字体大小,然后使用更改更改字体大小。
要显示默认的所有 JSDoc 注释,请打开“设置”对话框 ( ),转至编辑器 |一般|外观,然后选中渲染文档注释表单。CtrlAlt0S
如需隐藏渲染视图装订线图标,请从装订配置的上方菜单中选择“装订线图标”,然后清除“设置” | “就地渲染文档注释”表单。编辑|一般|打开的装订线图标页面。
感谢您的反馈意见!