Spec-Zone.ru › JSDoc

@summary

Содержание

  • Синтаксис
  • Обзор
  • Примеры
  • Связанные ссылки

Синтаксис

@summary Summary goes here.

Обзор

Тег @summary — это сокращённая версия полного описания. Его можно добавить к любому документу.

Примеры

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

Связанные ссылки

  • @classdesc
  • @description

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/tags-summary.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API