JsDoc Toolkitを使う!

インライン・ドックコメント

最終更新:

aias-jsdoctoolkit

- view
管理者のみ編集可

トップページ > ドックコメントの書き方 >

インライン・ドックコメント


インライン・ドックコメントは、関数(やコンストラクタ、メソッド)のパラメータや戻り値のデータ型をコード内への記述を可能にします。例えば以下のような場合を考えてみます。

/**
  @param {String} name
  @type Array
 */

function getPerson(name) {
}

上の例は、替わりにインライン・ドックコメントを使ってこのように書くことができます。

function getPerson( /**String*/ name) /**Array*/ {
}

複数のパラメータにも使えます。

function getPerson( /**String*/ name, /**City*/ birthplace) {
}

標準的なドックコメントとインライン・ドックコメントによるデータ型情報を混在させることもできます。

/**
  @param name The name of the person.
 */

function getPerson( /**String*/ name) {
}

標準的なドックコメントとインライン・ドックコメントの両方でデータ型が指定されていた場合、標準的なドックコメントの方が優先されます。下の例の場合、 name のデータ型は NameObject としてドキュメント化されます。

/**
  @param {NameObject} name The name of the person.
 */

function getPerson( /**String*/ name) {
}

関連項目


目安箱バナー