同义词
linkcodelinkplain
语法
{@link namepathOrURL} [链接文本]{@link namepathOrURL}
概述
{@link} 内联标签会创建指向你指定的名称路径或 URL 的链接。当你使用 {@link} 标签时，你还可以使用多种不同格式提供链接文本。如果你未提供任何链接文本，JSDoc 会使用名称路径或 URL 作为链接文本。
如果你需要链接到教程，请使用 {@tutorial} 内联标签，而不是 {@link} 标签。
链接格式化
默认情况下，{@link} 会生成标准 HTML 锚点标签。但是，你可能更喜欢使用等宽字体来呈现某些链接，或者指定各个链接的格式。你可以使用以下 {@link} 标签的同义词来控制链接的格式
{@linkcode}：强制链接的文本使用等宽字体。{@linkplain}：强制链接的文本显示为普通文本，不使用等宽字体。
你还可以设置 JSDoc 配置文件中的以下选项之一；有关更多详细信息，请参阅 配置 JSDoc
templates.cleverLinks：设置为true时，指向 URL 的链接使用普通文本，指向代码的链接使用等宽字体。templates.monospaceLinks：设置为true时，所有链接都使用等宽字体，但使用{@linkplain}标签创建的链接除外。
注意：虽然默认 JSDoc 模板正确呈现了所有这些标签，但其他模板可能无法识别 {@linkcode} 和 {@linkplain} 标签。此外，其他模板可能会忽略链接呈现的配置选项。
示例
以下示例展示了为 {@link} 标签提供链接文本的所有方法
/**
* See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
* Also, check out {@link http://www.google.com|Google} and
* {@link https://github.com GitHub}.
*/
function myFunction() {}
默认情况下，上面的示例会生成类似于以下内容的输出
{@link} 标签的输出See <a href="MyClass.html">MyClass</a> and <a href="MyClass.html#foo">MyClass's foo
property</a>. Also, check out <a href="http://www.google.com">Google</a> and
<a href="https://github.com">GitHub</a>.
如果将配置属性 templates.cleverLinks 设置为 true，则上面的示例会生成以下输出
See <a href="MyClass.html"><code>MyClass</code></a> and <a href="MyClass.html#foo">
<code>MyClass's foo property</code></a>. Also, check out
<a href="http://www.google.com">Google</a> and <a href="https://github.com">GitHub</a>.