JSDocタグ
出典: フリー百科事典『ウィキペディア（Wikipedia）』 (2021/06/13 07:49 UTC 版)
モダンなJSDocでよく使用されるアノテーションの一部を紹介する。 タグ説明@author 開発者の名前 @constructor 関数がコンストラクタ（constructor）であるという印をつける @deprecated 関数が非推奨（deprecated）であるという印をつける @exception @throwsの別名 @exports モジュールがexportするメンバーであることを指定する @param メソッドのパラメータをドキュメント化する。波括弧の中にデータ型の名前を書いて、パラメータ名の前に挿入することができる。 @private メンバーがprivateであることを示す @return 返り値をドキュメント化する @returns @returnの別名 @see 他のオブジェクトとの関連をドキュメント化する @todo 不足しているものや追加可能なもの（something open）をドキュメント化する @this 関数内で"this"というキーワードが指しているオブジェクトの型を指定する @throws メソッドが投げる例外をドキュメント化する @version ライブラリのバージョンナンバーを提供する
※この「JSDocタグ」の解説は、「JSDoc」の解説の一部です。
「JSDocタグ」を含む「JSDoc」の記事については、「JSDoc」の概要を参照ください。
ウィキペディア小見出し辞書の「JSDocタグ」の項目はプログラムで機械的に意味や本文を生成しているため、不適切な項目が含まれていることもあります。ご了承くださいませ。
お問い合わせ。
- JSDocタグのページへのリンク
