Результаты поиска по запросу "jsdoc"

1 ответ

Как отобразить методы Javascript в «группе» в JSDOC?

Есть ли возможность группировать функции внутри класса (модуль AMD / RequireJS)? Мои классы имеют иногда более 20+ функций, которые на самом деле принадлежат...

3 ответа

Задокументировать параметры универсального типа в JSDOC

ВJSDoc [http://usejsdoc.org/tags-type.html]существует возможность документировать точные типы содержимого массиванравится [http://usejsdoc.org/tags-type.html]: /** @param {Array.<MyClass>} myClasses An array of MyClass objects. ...

5 ответов

Как документировать строковый тип в jsdoc с ограниченными возможными значениями

У меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Как лучше всего документировать то же самое? Должен ли shapeType определяться как enum, TypeDef ...

ТОП публикаций

1 ответ

Как указать массив объектов в качестве параметра или возвращаемого значения в JSDoc?

3 ответа

Документирование функций-членов с помощью JSDoc

У меня есть что-то вроде этого:

2 ответа

Как документировать обратные вызовы с использованием JSDoc?

Учитывая функцию Javascript, которая принимает функции обратного вызова в качестве параметров: var myFunction = function(onSuccess, onFailure) {...}Как мне документироватьonSuccessвозвращаемый тип и аргументы?

3 ответа

Документирование функций-членов с помощью JSDoc

У меня есть что-то вроде этого: /** Diese Klasse bla bla... @constructor **/ my.namespace.ClassA = function(type) { /** This function does something **/ this.doSomething = function(param){ } }Класс будет указан в сгенерированной документации. ...

1 ответ

не совсем то, на что я надеялся, но LGTM

я перегружентумблерфункция и хотите документировать поведения с JSDoc. Если значение определено, состояние окна устанавливается равным логическому значению параметра Truey, если значение не определено, состояние окна переключается. Я ищу что-то ...

2 ответа

jsdoc: многострочное описание @property

Я документирую свой код с помощью jsdoc, пока все хорошо, у меня есть комментарий как ниже

1 ответ

Как расширить параметр typedef в JSDOC?