JSDoc 中文网

语法

¥Syntax

@summary Summary goes here.

概述

¥Overview

@summary 标签是完整描述的较短版本。它可以添加到任何 doclet 中。

¥The @summary tag is a shorter version of the full description. It can be added to any doclet.

示例

¥Examples

/**

 * A very long, verbose, wordy, long-winded, tedious, verbacious, tautological,

 * profuse, expansive, enthusiastic, redundant, flowery, eloquent, articulate,

 * loquacious, garrulous, chatty, extended, babbling description.

 * @summary A concise summary.
 */
function bloviate() {}