Я использую jQuery $.widget()
базовый класс, который предоставляет метод option()
. Поскольку метод не находится в моем коде, у меня нет места для документирования аргумента.
Я попытался поместить jsDoc в поля в литере опций по умолчанию, но их просто не подхватили. Затем я попытался использовать теги @class
и @lends
в одном и том же объектном литерале, но это может быть довольно запутанным, поскольку литерал объекта не является действительно классом.
Еще одна альтернатива, которую я экспериментировал, заключается в том, чтобы добавить что-то вроде @param options.field description
в конструкторе jsDoc. Однако это имеет недостаток в том, чтобы отделить документацию от кода. Кроме того, конструктор фактически не имеет аргумента, называемого options
, поскольку все его обрабатывает jQuery.
Как вы справляетесь с этим Javascript-гуру? Должен ли предлагаться новый тег?