> JSDoc在线手册 > @summary

@summary


描述:完整描述的一个简写版本。

语法

@summary Summary goes here.

概述

@summary标签是完整描述的一个简写版本。它可以被添加到任何的doclet。

例子

/**
 * 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() {}

上一篇:
下一篇: