Вопросы с тегом «jsdoc»

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

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Но как мне описать, как должен быть структурирован объект параметров? Например, это должно быть что-то вроде: {...

119
Как указать, что параметр является необязательным, используя встроенный JSDoc?

Согласно вики JSDoc для @param вы можете указать, что @param является необязательным, используя /** @param {String} [name] */ function getPerson(name) { } и вы можете указать встроенный параметр, используя function getPerson(/**String*/ name) { } И я могу объединить их следующим образом, и это...

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

В JSDoc лучшая документация, которую я могу найти, показывает, как использовать следующее, если у вас есть массив определенного типа (например, массив строк), например: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Как бы вы...

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

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

89
Документируйте параметр деструктурированной функции в JSDoc

Раньше я всегда документировал параметры своего объекта следующим образом: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config = {}) { const...

84
Правильный способ документирования функций с открытым аргументом в JSDoc

Допустим, у вас есть что-то вроде следующего: var someFunc = function() { // do something here with arguments } Как бы вы правильно задокументировали, что эта функция может принимать любое количество аргументов в JSDoc? Это мое лучшее предположение, но я не уверен, что оно верное. /** * @param...

84
Как указать разрешение и тип отклонения обещания в JSDoc?

У меня есть код, который возвращает объект обещания, например, используя библиотеку Q для NodeJS. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } Как задокументировать такое возвращаемое значение с помощью...

81
Как вернуть void в JsDoc?

Есть ли указанный способ объявить метод или функцию для возврата void в JsDoc? В настоящее время я считаю, что voidэто возвращаемое значение по умолчанию, и другие возвращаемые значения должны быть указаны специально: /** * @return {Integer} The identifier for ... */...