JSDoc: Как документировать литерал объекта «options» для родительского «класса»? [дубликат]

На этот вопрос уже есть ответы здесь:

Как описать «объектные» аргументы в jsdoc?(5 ответов)

Закрыто 3 года назад.

Я использую базовый «класс» jQuery $.widget(), который предоставляет метод option(). Поскольку этого метода нет в моем коде, у меня нет места для документирования аргумента.

Я пытался поместить jsDoc в поля литерала опций по умолчанию, но они просто не подхватывались. Затем я попытался использовать теги @classи @lendsдля одного и того же литерала объекта, но это может сбивать с толку, поскольку литерал объекта на самом деле не является классом.

Другая альтернатива, которую я экспериментировал, заключается в том, чтобы поместить что-то вроде @param options.field descriptionв jsDoc конструктора. Однако недостатком этого является отделение документации от кода. Кроме того, у конструктора на самом деле нет аргумента с именем options, так как все это обрабатывается jQuery.

Как вы, гуру Javascript, справляетесь с этим? Следует ли предложить новый тег?

javascript jsdoc

задан alex 26 February 2016 в 13:20

0 ответов

Другие вопросы по тегам:

javascript jsdoc

JSDoc: Как документировать литерал объекта «options» для родительского «класса»? [дубликат]

0 ответов

Похожие вопросы: