@link - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 > タグリファレンス >

@link

@linkタグは他のタグテキストの中に挿入して、ドキュメント内の他の要素へのHTMLリンクを作成することができます。

• http://code.google.com/p/jsdoc-toolkit/wiki/TagLink

構文

@anyTag This is some text {@link otherSymbol}.

• anyTag -- 他のタグ
• otherSymbol -- 必須：リンク先の要素のネームパス

例

/**
 * This is similar to a {@link Printer} object but can also print to files.
 */

function Writer() {
}

注意：JsDocToolkitはドキュメント内から Printer を自動的に探し出し、HTMLリンクを作成します。

関連項目

• @linkタグは@seeタグと似た動作をするものの、@seeタグの中にこのタグを記述することはできません。

---