JSDoc中文文档(@use JSDoc)

JSDoc {@link}

目录

同义词

语法

{@link namepathOrURL}
[link text]{@link namepathOrURL}
{@link namepathOrURL|link text}
{@link namepathOrURL link text (after the first space)}

概述

{@link}内联标签创建一个链接到您指定的namepathURL。 当您使用{@link}标签,还可以提供几种不同的格式的链接文本。 如果你不提供任何链接文本,JSDoc使用namepathURL作为链接文字。

如果您需要链接到一个教程,使用{@tutorial} 内联标签 代替{@link}标签。

默认情况下,{@link}生成标准的HTML锚点标记。但是,你可能更愿意在某些环节用等宽字体呈现,或指定单个链接的格式。您可以使用{@link}标签的同义词来控制链接的格式:

您还可以在JSDoc的配置文件中设置下列选项之一;详情参见配置 JSDoc

注意: 虽然默认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,上面的例子会输出:

示例: Output with clever links enabled
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>.