Результаты поиска по запросу "jsdoc"
Как документировать строковый тип в jsdoc с ограниченными возможными значениями
У меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Как лучше всего документировать то же самое? Должен ли shapeType определяться как enum, TypeDef ...
утверждение), хотя функция на самом деле не использует этот параметр.
тим, у вас есть что-то вроде следующего: var someFunc = function() { // do something here with arguments }Как бы вы правильно задокументировали, что эта функция может принимать любое количество аргументов в JSDoc? Это мое лучшее предположение, ...
и 'c' (любой тип)
ой вопрос, как мне документировать этот «смешанный тип»? Я знаю, что мог бы просто перечислить все возможные типы, как{null|undefined|String|Number|Object} и заканчиваю тем, что обнаружил, что скучаю по одному и сделал его слишком сложным Я ...
не совсем то, на что я надеялся, но LGTM
я перегружентумблерфункция и хотите документировать поведения с JSDoc. Если значение определено, состояние окна устанавливается равным логическому значению параметра Truey, если значение не определено, состояние окна переключается. Я ищу что-то ...
Документирование функций-членов с помощью JSDoc
У меня есть что-то вроде этого: /** Diese Klasse bla bla... @constructor **/ my.namespace.ClassA = function(type) { /** This function does something **/ this.doSomething = function(param){ } }Класс будет указан в сгенерированной документации. ...
Как документировать словарь в JSDoc?
Имея следующий пример: var CONF = { locale: { "en": { name: "English", lang: "en-US" }, "es": { name: "Spanish", lang: "es-ES" } } };И зная, что свойство locale содержит объект словаря, который поступает из базы данных, как я могу ...
Диаграмма JSDoc UML
Вопрос: Я редактирую и использую библиотеку JavaScript с открытым исходным кодом, в которой есть теги JSDoc. Мне было интересно, знает ли кто-нибудь о плагине JSDoc, который позволил бы мне создать диаграмму классов из тегов JSDoc. Изменить я ...
Как мне JSDoc Методы Вложенного Объекта?
Я пытался использовать JSDoc3 для создания документации по файлу, но у меня возникли некоторые трудности. Файл (который является модулем Require.js) в основном выглядит так: define([], function() { /* * @exports mystuff/foo */ var foo = { /** * ...
(Мы используем require.js.)
ибудь документировал код BackboneJS с помощью JSDoc? У меня проблемы с аннотированием конструкций Backbone, таких как: User = Backbone.Model.extend({ defaults: { a: 1 }, initialize: function () { // ... }, doSomething: function (p) { // ... } ...
JSDoc с AngularJS
В настоящее время в моем проекте мы используем JSDoc, недавно мы начали внедрять Angular, и я хочу продолжать использовать JSDoc, чтобы гарантировать, что вся документация находится в одном месте. Я взглянул на людей, которые в основном говорят, ...