@yields

Оглавление

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

Синонимы

@yield

Синтаксис

@yields [{type}] [description]

Обзор

Тег @yields документирует значение, возвращаемое функцией-генератором. Этот тег доступен в JSDoc 3.5.0 и более поздних версиях.

Если вы документируете обычную функцию, используйте тег @returns вместо этого тега.

Примеры

/**
 * Generate the Fibonacci sequence of numbers.
 *
 * @yields {number}
 */
function* fibonacci() {}

/**
 * Generate the Fibonacci sequence of numbers.
 *
 * @yields {number} The next number in the Fibonacci sequence.
 */
function* fibonacci() {}

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

@returns