@use JSDoc

類義語

構文

@description <何らかの説明>

概要

@description タグを使用すると、文書化するシンボルの一般的な説明を提供できます。説明には HTML マークアップを含めることができます。また、Markdown プラグイン が有効になっている場合は、Markdown 形式を含めることもできます。

例

JSDoc コメントの一番最初にブロック タグを使用する前にシンボルを説明する場合、@description タグを省略できます。

@description タグなしでシンボルを説明する
/**
 * Add two numbers.
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function add(a, b) {
    return a + b;
}

@description タグを使用すれば、JSDoc コメントのどこでも説明を配置できます。

@description タグでシンボルを説明する
/**
 * @param {number} a
 * @param {number} b
 * @returns {number}
 * @description Add two numbers.
 */
function add(a, b) {
    return a + b;
}

JSDoc コメントの先頭の説明と @description タグで提供される説明の両方が存在する場合、@description で指定された説明が、コメントの先頭の説明を上書きします。