@description (@desc)【説明】
{@link} ({@linkcode}・{@linkplain})【インラインリンク】
@see【参照】
@summary【概要】
@todo【TODO】

@description (@desc)【説明】

メモ

  • 各種項目の説明を記述
  • 先頭のブロックタグであれば省略可

構文

@description 【説明:対象の長い説明】
シノニム:@desc

関連

/**
 * 関数の説明 (@description 省略)
 * @param p パラメータの説明
 */
function descFunc(p) { }

/**
 * @param p パラメータの説明
 * @description 関数の説明
 */
function descFunc2(p) { }


@see【参照】

メモ

構文

@see 【名前パス:自動的にリンク設定】
@see 【フリーフォーマットのテキスト:リンクなしの説明】

関連

/**
 * 関数の説明
 * @see seeClass
 * @see 【フリーフォーマットのテキスト】
 * @see {@link http://usejsdoc.org/tags-see.html @use JSDoc:@see}
*/
function seeFunc() { }

/**
 * クラスの説明
 */
class seeClass { }

@summary【概要】

メモ

  • 概要を記述

構文

@summary 【概要:対象の短い説明】

関連

/**
 * 関数の説明
 * @summary 関数の概要
 */
function func() {
  /* 処理 */
}

@todo【TODO】

メモ

  • TODOを記述
  • 複数指定可

構文

@todo 【TODO テキスト】

関連

/**
 * 関数の説明
 * @param p1
 * @todo 関数の説明を分かり易く
 * @todo 引数の型・説明を追加
 */
function func(p1) {
  /* 処理 */
}