@use JSDoc

同義語

構文

{@link namepathOrURL} [link text]{@link namepathOrURL}

概要

インラインタグの {@link} は、指定した namepath または URL へのリンクを作成します。{@link} タグを使用すると、いくつかの異なるフォーマットを用いてリンクテキストを提供できます。リンクテキストを提供しない場合、JSDoc は namepath または URL をリンクテキストとして使用します。

チュートリアルにリンクする必要がある場合は、{@link} タグではなく、{@tutorial} インラインタグ を使用します。

デフォルトでは、{@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 に設定されている場合、上記の例は次の出力を生成します。

clever link が有効な場合の出力
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>.