開発者ブログ
HTML5資料室 » JSDoc3

JSDoc3

Last modified by masaru-yokoyama on 2013/07/29, 14:32

最新バージョン

  • 3.2.0

タグ一覧

タグ

タグ名詳細
@abstract継承またはオーバーライドで実装されるクラスであることを文章化する
@acecss <private|protected|public>アクセス修飾子を文章化する (@private @protected @publicでも代替可能)
@alias <aliasNamepath>エイリアス(別名)を文章化する
@augments [<namepath>]どのクラスを継承しているか文書化する。継承するクラス・継承されるクラスともに@constructorまたは@classが必須。このタグは継承するクラスに記述する
@author <name> [<emailAddress>]制作者の情報を文章化する
@extends [<namepath>]@augmentsと同様
@borrows [<that namepath>] as [<this namepath>]オブジェクトとオブジェクトの関連を文書化する
@callbackコールバック関数に関する情報を文章化する
@classdescクラスに関する説明を文書化する
@class [<type> <name>]new演算子によってインスタンス化されるコンストラクタ関数であることを文書化する
@const [<type> <name>]@constantと同様
@constant [<type> <name>]定数値であることを文書化する
@constructor [<type> <name>]@classと同様
@constructors [<name>]あるクラスのインスタンスを構築するために使用されるオブジェクトであることを文章化する(prototypeを定義するオブジェクトなどが該当する)
@copyright [<text>]著作権に関する情報を文書化する
@constructsコンストラクタに対して指定する
@default [<value>]デフォルト値を文書化する
@deprecated [<text>]Deprecated項目として文書化する
@desc [<text>]オブジェクトに関する説明を文書化する
@description@descと同様
@enum静的プロパティのコレクションを文書化する
@event [<EventName>]Events項目として文書化する(通常、何も指定しない場合はMembersとして文書化される)
@example [<text>]例文を文書化する
@exception [<namepath>]@throwsと同様
@exports [<namepath>]Module項目として文書化する
@fileファイルの概要を文章化する
@overview@fileと同様
@fileoverview@fileと同様
@fires [<EventName>]発火するイベント名を文書化する
@functionMethods項目として文書化する(通常、何も指定しない場合はMembersとして文書化する)
@globalこのオブジェクトがグローバルオブジェクトであることを文書化する
@ignore指定した項目をjsDocとして文書化しない
@innerある名前空間の内部メンバであることを文章化する。
@instanceinstanceオブジェクトとして文書化する(何も指定しない場合はstaticとして文書化する)
@kind@typeとは異なるシンボルの種類(クラスやモジュール)を文章化する。@namespace は @kind namespace、@class は @kind class のように書くことができるが、通常使用する必要はない
@license [<text>]ライセンス情報として文書化する
@member [<namepath>]namepathで指定した名前空間のメンバとして文書化される
@var@memberと同様
@memberof [<namepath>]現在所属しているオブジェクトの他に、他のオブジェクトのメンバとして文書化する
@method@functionと同様
@mixes <OtherObjectPath>OtherObjectPathに指定したオブジェクトからすべてのメンバを、このタグを指定したオブジェクトが含んでいることを文章化する
@mixinmixinオブジェクトであることを文章化する。
@moduleモジュールであることを文書化する
@name [<name>]nameで指定した文字列が、オブジェクト名として文書化する。(通常は、ソースコードに書かれている変数名が、オブジェクト名として文書化する)
@arg@paramと同様
@namespaceオブジェクトがそのメンバの名前空間であることを文章かする
@param [<name> <type> <description>]関数のパラメータの詳細について文書化する
@argument@paramと同様
@privateprivateオブジェクトとして文書化する(このタグを指定した場合、デフォルト設定だとjsdocに出力されない)
@property [<name> {<type>} <description>]Properties項目として文書化する
@protectedprotectedオブジェクトとして文書化する
@publicpublicオブジェクトとして文書化する
@readonlyreadonlyオブジェクトとして文書化する
@requiresあるモジュールが他のモジュールにrequireされた状態を文書化する
@return [type] [text]戻り値の詳細を文書化する
@returns [type] [text]@returnと同様
@see [<namepath>]namepathのドキュメントへのリンクを作成する。
@since [<text>]この機能がいつから追加されたかを文章化する
@summary [<text>]簡略化された説明を文章化する
@this [<value>]コンテキストの型を文書化する
@throws [<namepath>]例外を文書化する
@todo [<text>]TODOを文書化する
{@tutorial <tutorialID>}チュートリアルが含まれているファイルへのリンクを文章化する
@type [<value>]型情報を文書化する
@typedef [<value>]カスタム型を文書化する
@variation <variationNumber>階層は異なるが同じオブジェクト名を持っている場合、区別するために使用する。
例えば、a.Hogeとa.b.Hogeのような空間を持っていたとして、{@link Hoge}のようにドキュメントに記述した場合、a.Hogeなのかあるいなどa.b.Hogeなのかを識別するため、@variationタグを指定したオブジェクトに対して{@link Hoge(2)}のように記述する
@version [<text>]バージョン情報として文書化する

インラインタグ

ドキュメント中やタグの記述の中で使用できるタグ

タグ名詳細
{@link 名前空間またはURL}例) {@link h5.core.controller}、 {@link http://www.htmlhifive.com/}
HTMLは「<a href="#"><code>fooBar</code></a>」のようにcodeタグを含んで出力される。
{@linkcode 名前空間またはURL}@linkと同様。
例) {@linkcode h5.core.controller}、 {@linkcode http://www.htmlhifive.com/}
HTMLは「<a href="#"><code>fooBar</code></a>」のようにcodeタグを含んでいる。
{@linkplain 名前空間またはURL}例) {@linkplain h5.core.controller}、 {@linkplain http://www.htmlhifive.com/}
HTMLは「<a href="#">fooBar</a>」のようにcodeタグが無い。
{@tutorial チュートリアルID}チュートリアル(@tutorialが指定されているドキュメント)へリンクするために使用する。

参考リンク

usejsdoc.org (本家サイト)
JsDoc3-manual-jp

hifive
 チュートリアル(基本編)/ 08.ドキュメント記述・生成(JSDoc) 


Copyright (C) 2012-2017 NS Solutions Corporation, All Rights Reserved.