@see - JsDoc Toolkitを使う！

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

@see

@seeタグは、この項目と関連する他の要素や外部リソースへのリンクを作成します。

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

構文

@see seeDescription

• seeDescription -- 必須：参照先リソースの説明

例

最初の単語がドキュメント内の要素の場合、その要素へのリンクが作成されます。そうでなければ、テキストはHTMLテキストとして入力されたまま出力されます。（@linkタグは機能しないということです）

/**
 * @see ClassName#methodName
 * @see The <a href="http://www.example.com">Example Project</a>.
 */

関連項目

• @linkタグは@seeタグの外部で、@seeタグと同じような働きをさせるために使うことができます。

---