@use JSDoc

语法

概述

@see 标记允许您参考可能与正在记录的符号或资源相关的另一个符号或资源。您可以提供符号的名称路径或自由文本。如果您提供名称路径,JSDoc 的默认模板会自动将名称路径转换为链接。

示例

使用 @see 标记
/**
 * 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() {}