JSDoc リファレンス メモ

※ メニューは左側ナビ

  • JSDoc3 (JavaScript用のAPIドキュメントジェネレータ) のメモ
  • /** ~ */ コメント内に記述 (/* ~ *//*** ~ */ 等は対象外)
  • Google Closure Compiler (検証・圧縮・最適化・可読化)等のツールで補助的に使用

起動

起動指定備考
jsdoc 起動オプション ソースファイル名 (複数:スペース区切り) ファイル指定
(READMEファイルも有効)
jsdoc module1.js module2.js
jsdoc 起動オプション ソースファイル ディレクトリ名ディレクトリ指定jsdoc src

出力:./out ディレクトリ (デフォルト)
(-d・--destination オプションで指定)

起動オプション

オプション説明複数指定外部ファイル
-a <value>--access <value> 指定アクセス属性のみ出力 (<value>:private | protected | public | undefined | all )
(デフォルト:private以外を全て出力)
-c <value>--configure <value> コンフィグファイル指定
(デフォルト:インストールパスの"conf.json" または "conf.json.EXAMPLE")
-d <value>--destination <value> 出力パス (デフォルト:./out)
--debugデバッグ情報表示
-e <value>--encoding <value> ソースファイルのエンコード形式 (デフォルト:utf8)
-h--help起動オプションのヘルプ表示
--match <value>指定名のみテスト
--nocolorコンソール出力の色付けなし
-p--private @private【private定義】も対象 (デフォルト:対象外)
-P <file>--package <file> プロジェクト名・バージョン等を含むパッケージファイル
(デフォルト:ソースパスの"package.json")
--pedanticエラーを致命的エラー・警告をエラー扱い (デフォルト:なし)
-q <value>--query <value> クエリ文字列をグローバル変数 (env.opts.query) に設定
-r--recurse ソースファイル・チュートリアルファイルのサブディレクトリを再帰的に走査
-R <file>--readme <file> READMEファイル指定
(デフォルト:ソースファイルディレクトリで最初に見つかったREADME.md)
-t <file>--template <file> テンプレートのパス (デフォルト:templates/default)
-T--test実行テスト (結果はコンソール出力)
-u <value>--tutorials <value> チュートリアルファイルのディレクトリ (デフォルト:未使用)
-v--versionJSDocのバージョン表示
--verbose詳細情報出力 (デフォルト:なし)
-X--explain全ドックレット(JSON形式)をコンソール出力

(一部はコンフィグファイルに指定可能)


タグ一覧

( ※指定 )

タグ 構文定義シノニム JC説明
@abstract@virtual 抽象メンバ
@access アクセスレベル アクセスレベル
@alias 別名エイリアス
@arg [ {} ] 引数名 [[ - ]説明] @param引数
@argument [ {} ] 引数名 [[ - ]説明] @param引数
@async 非同期関数
@augments 継承クラス @extends 継承
@author 開発者名 [<メールアドレス>] 開発者
@borrows 借用元名 as 借用名 借用元オブジェクト
@callback コールバック名 コールバック関数
@class [クラス名] @constructor クラス (new 呼び出し関数)
@classdesc クラスの説明 クラスの説明
@const [ {} ] @constant 定数値
チェック・インライン化
@constant [ {} ] @const 定数値
@constructor [クラス名]
@constructor
@class クラス (new 呼び出し関数)
@constructs [コンストラクタ名] コンストラクタ
@copyright 著作権情報の説明 著作権情報
@default [デフォルト値] @defaultvalue デフォルト値
@defaultvalue [デフォルト値] @defaultデフォルト値
@define {} [説明] 定義値
(--define フラグ でオーバーライド可能)
@deprecated [非推奨の説明]
@deprecated 非推奨の説明
非推奨
@desc 説明 @description説明
@description 説明 @desc 説明
@dict 角括弧によるプロパティ アクセスのみ可能
@emits クラス名#[イベント:]イベント名 @fires発生イベント
@enum [ {} ] 列挙子
@event クラス名#[イベント:]イベント名 イベント
@example 使用例 (複数行可) 使用例
@exception 説明
@exception {}
@exception {} 説明
@throws例外
@export [] シンボル エクスポート
(--generate_exportsフラグ)
@exports モジュール名 エクスポート
@extends 継承クラス
@extends {継承クラス}
@augments 継承
@external
@external 外部参照名
@host 外部参照
@externs 外部参照定義ファイル
@file ファイルの概要 @fileoverview
@overview
ファイル概要
@fileoverview ファイルの概要 @file ファイル概要
@final 継承不可クラス
オーバーライド不可メソッド
@fires クラス名#[イベント:]イベント名 @emits 発生イベント
@func [関数名] @function関数・メソッド
@function [関数名] @func
@method
関数・メソッド
@generator ジェネレータ関数
@global グローバル出力
@hideconstructor コンストラクタ非表示
@host
@host 外部参照名
@external外部参照
@ignore 出力無効
@implements {} インタフェース実装
@implicityCast 型割り当て
@inheritdoc
@inheritDoc
文書継承
@inner 内部オブジェクト
@instance インスタンスメンバ
@interface [インタフェース名]
@interface
インタフェース
@kind 種類 種類
@lends 所属名
@lends {オブジェクト名}
所属
@license ライセンスの説明 ( @preserve ) ライセンス (シノニム:@preserve )
{@link 名前パス or URL}
[リンクのテキスト] {@link 名前パス or URL}
{@link  名前パス or URL|リンクのテキスト}
{@link 名前パス or URLリンクのテキスト}
{ @linkcode }
{ @linkplain }
インラインリンク
{@linkcode 名前パス or URL}
[リンクのテキスト] {@linkcode 名前パス or URL}
{@linkcode  名前パス or URL|リンクのテキスト}
{@linkcode 名前パス or URLリンクのテキスト}
{@link}インラインリンク
{@linkplain 名前パス or URL}
[リンクのテキスト] {@linkplain 名前パス or URL}
{@linkplain  名前パス or URL|リンクのテキスト}
{@linkplain 名前パス or URLリンクのテキスト}
{@link}インラインリンク
@listens イベント名 イベントリスト
@member [ {} ] [説明] @var メンバ
@memberof 所属名のパス
@memberof! 所属名のパス
メンバの所属
@method [関数名] @function関数・メソッド
@mixes オブジェクト パス ミックスされたオブジェクト
@mixin [Mixin 名] Mixin オブジェクト
@modifies { this | 引数} this または 引数が未使用時、
Closure Compiler による削除許可
@module [ [ {} ] モジュール名] JavaScript モジュール
@name オブジェクト名 オブジェクト名
@namespace [[ {} ] 名前空間名] 名前空間
@noalias エイリアス禁止
(外部参照定義ファイルで使用)
@nocollapse プロパティ名の変更抑止
@nocompile コンパイル抑止
(ファイルの先頭に記述、コンパイル テスト用)
@nosideeffects 戻り値が未使用時、
Closure Compiler による削除許可
@override オーバーライド
@overview ファイルの概要 @fileファイル概要
@package パッケージ プライベート
(同一ディレクトリ内のコードのみアクセス可)
@param  [ {} ] 引数名 [[ - ]説明]
@param {} 引数名 [[ - ]説明]
@arg
@argument
引数
@polymer  
@polymerBehavior  
@preserve ライセンスの説明 @license ライセンス
@private
@private [ {} ]
private定義
@prop [ {} ] プロパティ名 [[ - ]説明] @propertyプロパティ
@property [ {} ] プロパティ名 [[ - ]説明] @prop プロパティ
@protected
@protected [ {} ]
protected定義
@public public定義
@readonly 読み取り専用
@record インタフェース
@requires モジュール名 必須モジュールファイル
@return [ {} ] [説明]
@return {} [説明]
@returns 戻り値
@returns [ {} ] [説明] @return 戻り値
@see 名前パス
@see フリーフォーマットのテキスト
参照
@since 有効(追加した)バージョン 有効バージョン
@struct 固定数のプロパティを持つオブジェクト
(ドット参照のみ可・プロパティ追加不可)
@static 静的メンバ
@summary 概要 概要
@suppress {警告カテゴリ リスト}
警告カテゴリ リスト:| または , 区切り
警告抑止
@template T テンプレート
@this 名前パス
@this {}
this 参照
@throws [ {} ] [説明] (1つは必要)
@throws {} [説明]
@exception 例外
@todo TODO TODO
@tutorial チュートリアル識別子 チュートリアルへのリンク
{@tutorial チュートリアル識別子}
[リンクのテキスト] {@tutorial チュートリアル識別子}
{@tutorial  チュートリアル識別子|リンクのテキスト}
{@tutorial チュートリアル識別子 リンクのテキスト}
チュートリアルへの
インラインリンク
@type {}
@typedef [ {} ] 名前パス
@typedef {}
型定義
@unrestricted 制限なし (省略可)
(@struct・@dict 以外)
@var [ {} ] [説明] @memberメンバ
@variation 区別番号 同一名の区別
@version バージョン バージョン
@virtual@abstract抽象メンバ
@yield [ {} ] [説明] (1つは必要) @yieldsジェネレータ関数の戻り値
@yields [ {} ] [説明] (1つは必要) @yield ジェネレータ関数の戻り値
J:JSDoc3 対応
C:Closure Compiler 対応

関連