@generator
Содержание
Синтаксис
@generator
Обзор
Тег @generator указывает, что функция является генератором функций, то есть она была объявлена с помощью синтаксиса function* foo() {}. Этот тег доступен в JSDoc 3.5.0 и более поздних версиях.
В общем случае, вам не нужно использовать этот тег, так как JSDoc автоматически обнаруживает генераторы функций и определяет их в сгенерированной документации. Однако, если вы пишете виртуальный комментарий для генератора функций, который не отображается в вашем коде, вы можете использовать этот тег, чтобы указать JSDoc, что функция является генератором функций.
Пример
Следующий пример демонстрирует виртуальный комментарий, который использует тег @generator:
© 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-generator.html
