JSDoc: Как мне документировать литерал объекта «options» для родительского «класса»? [Дубликат]
На этот вопрос уже есть ответ:
Как описать «объектные» аргументы в jsdoc? 5 ответов Я использую jQuery's$.widget() базовый «класс», который обеспечиваетoption() метод. Поскольку метод отсутствует в моем коде, у меня нет места для документирования аргумента.
Я пытался поместить jsDoc в поля литерала опций по умолчанию, но они просто не собраны. Тогда я попытался использовать@class а также@lends теги на одном и том же литерале объекта, но это может сбивать с толку, поскольку литерал объекта на самом деле не является классом.
Еще одна альтернатива, которую я экспериментировал, это поставить что-то вроде@param options.field description в конструкторе jsDoc. Однако у этого есть недостаток отделения документации от кода. Кроме того, конструктор на самом деле не имеет аргумента под названиемoptions поскольку все это обрабатывается jQuery.
Как вы, гуру Javascript, справляетесь с этим? Должен ли быть предложен новый тег?