@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) { }

メモ

構文

{@link リンク先の 名前パス または URL} 
[リンクのテキスト]{@link リンク先の 名前パス または URL} 
{@link リンク先の 名前パス または URL|リンクのテキスト} 
{@link リンク先の 名前パス または URLリンクのテキスト} 

シノニム：{@linkcode}・{@linkplain}
：１つ目のスペース

例

/**
 * 詳細は、{@link https://jsdoc.app/tags-inline-link.html}<br>
 * 詳細は、[リンク]{@link https://jsdoc.app/tags-inline-link.html}<br>
 * 詳細は、{@link https://jsdoc.app/tags-inline-link.html|リンク}<br>
 * 詳細は、{@link https://jsdoc.app/tags-inline-link.html リンク}
*/

@see【参照】

メモ

構文

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

例

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

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

@summary【概要】

メモ

構文

@summary 概要：対象の短い説明

例

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

@todo【TODO】

メモ

構文

@todo TODO テキスト

例

/**
 * 関数の説明
 * @param p1
 * @todo ＴＯＤＯ１
 * @todo ＴＯＤＯ２
 */
function func(p1) {
  /* 処理 */
}