インデックス

はじめに

JSDoc入門: JSDocを使ったJavaScriptドキュメント作成のクイックスタート。
JSDocでのnamepathの使用: JSDocでnamepathを使用するためのガイド。
JSDocへのコマンドライン引数: JSDocへのコマンドライン引数について。
設定ファイルを使用したJSDocの設定: 設定ファイルを使用してJSDocを設定する方法。
JSDocのデフォルトテンプレートの設定: JSDocのデフォルトテンプレートからの出力を設定する方法。
ブロックタグとインラインタグ: JSDocのブロックタグとインラインタグの概要。
JSDocプラグインについて: JSDocプラグインの作成と使用方法。
Markdownプラグインの使用: JSDocでMarkdownサポートを有効にする。
チュートリアル: APIドキュメントにチュートリアルを追加する。
パッケージファイルの包含: ドキュメントにパッケージの詳細を表示する方法。
READMEファイルの包含: ドキュメントにREADMEファイルを含める方法。
ライセンス: JSDocのライセンス情報。

JSDocの例

ES 2015クラス: ECMAScript 2015クラスにJSDocコメントを追加する方法。
ES 2015モジュール: ECMAScript 2015モジュールにJSDocコメントを追加する方法。
CommonJSモジュール: CommonJSおよびNode.jsモジュールにJSDocコメントを追加する方法。
AMDモジュール: AMDおよびRequireJSモジュールにJSDocコメントを追加する方法。

ブロックタグ

@abstract (同義語: @virtual): このメンバーは、継承者によって実装（またはオーバーライド）する必要があります。
@access: このメンバーのアクセスレベルを指定します（private、package-private、public、またはprotected）。
@alias: メンバーを、異なる名前を持つものとして扱います。
@async: 関数が非同期であることを示します。
@augments (同義語: @extends): シンボルが親シンボルから継承し、それに追加されることを示します。
@author: アイテムの作者を特定します。
@borrows: このオブジェクトは別のオブジェクトから何かを使用します。
@class (同義語: @constructor): この関数は、「new」キーワードを使用して呼び出すことを目的としています。
@classdesc: クラス全体を説明するには、次のテキストを使用します。
@constant (同義語: @const): オブジェクトを定数として記述します。
@constructs: この関数メンバーは、前のクラスのコンストラクタになります。
@copyright: 著作権情報を記述します。
@default (同義語: @defaultvalue): デフォルト値を記述します。
@deprecated: これがもはや推奨されない方法であることを記述します。
@description (同義語: @desc): シンボルを説明します。
@enum: 関連するプロパティのコレクションを記述します。
@event: イベントを記述します。
@example: 記述されたアイテムの使用方法の例を示します。
@exports: JavaScriptモジュールによってエクスポートされるメンバーを特定します。
@external (同義語: @host): 外部クラス、名前空間、またはモジュールを識別します。
@file (同義語: @fileoverview, @overview): ファイルを説明します。
@fires (同義語: @emits): このメソッドが発行する可能性のあるイベントについて説明します。
@function (同義語: @func, @method): 関数またはメソッドを説明します。
@generator: 関数がジェネレータ関数であることを示します。
@global: グローバルオブジェクトを記述します。
@hideconstructor: コンストラクタを表示しないように指示します。
@ignore: ドキュメントからシンボルを省略します。
@implements: このシンボルはインターフェースを実装します。
@inheritdoc: シンボルが親のドキュメントを継承することを示します。
@inner: 内部オブジェクトを記述します。
@instance: インスタンスメンバーを記述します。
@interface: このシンボルは、他のものが実装できるインターフェースです。
@kind: これはどのような種類のシンボルですか？
@lends: オブジェクトリテラルのプロパティを、指定された名前を持つシンボルに属しているかのように記述します。
@license: このコードに適用されるライセンスを特定します。
@listens: シンボルがリスンするイベントを一覧表示します。
@member (同義語: @var): メンバーを記述します。
@memberof: このシンボルは親シンボルに属します。
@mixes: このオブジェクトは、別のオブジェクトからすべてのメンバーをミックスインします。
@mixin: mixinオブジェクトを記述します。
@module: JavaScriptモジュールを記述します。
@name: オブジェクトの名前を記述します。
@namespace: 名前空間オブジェクトを記述します。
@override: シンボルが親をオーバーライドすることを示します。
@package: このシンボルはパッケージプライベートを目的としています。
@param (同義語: @arg, @argument): 関数の引数を記述します。
@private: このシンボルはプライベートを目的としています。
@property (同義語: @prop): オブジェクトのプロパティを記述します。
@protected: このシンボルはプロテクトを目的としています。
@public: このシンボルはパブリックを目的としています。
@readonly: このシンボルは読み取り専用を目的としています。
@requires: このファイルはJavaScriptモジュールを必要とします。
@returns (同義語: @return): 関数の戻り値を記述します。
@see: 詳細については、他のドキュメントを参照してください。
@since: この機能はいつ追加されましたか？
@static: 静的メンバーを記述します。
@summary: 完全な説明の短いバージョン。
@this: ここで「this」キーワードは何を参照していますか？
@throws (同義語: @exception): 発生する可能性のあるエラーについて説明します。
@todo: 完了するタスクを記述します。
@tutorial: 含まれているチュートリアルファイルへのリンクを挿入します。
@type: オブジェクトの型を記述します。
@typedef: カスタム型を記述します。
@variation: 同じ名前の異なるオブジェクトを区別します。
@version: アイテムのバージョン番号を記述します。
@yields (同義語: @yield): ジェネレータ関数によって生成される値を記述します。

インラインタグ

@link (同義語: @linkcode, @linkplain): ドキュメント内の別のアイテムへのリンク。
@tutorial: チュートリアルへのリンク。

貢献

GitHub上のJSDocプロジェクト: JSDocへの貢献。
GitHub上のJSDocドキュメントプロジェクト: JSDocドキュメントへの貢献。

GitHubでフォーク