语法
¥Syntax
-
@see <namepath> -
@see <text>
概述
¥Overview
@see 标签允许你引用可能与正在记录的符号或资源相关的另一个符号或资源。你可以提供符号的名称路径或自由格式文本。如果你提供名称路径，JSDoc 的默认模板会自动将名称路径转换为链接。
¥The @see tag allows you to refer to another symbol or resource that may be related to the one being documented. You can provide either a symbol's namepath or free-form text. If you provide a namepath, JSDoc's default template automatically converts the namepath to a link.
示例
¥Examples
/**
* Both of these will link to the bar function.
* @see {@link bar}
* @see bar
*/
function foo() {}
// Use the inline {@link} tag to include a link within a free-form description.
/**
* @see {@link foo} for further information.
* @see {@link http://github.com|GitHub}
*/
function bar() {}