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

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

316 javascript  jsdoc 

Как я могу сообщить JSDoc о структуре возвращаемого объекта. Я нашел @return {{field1: type, field2: type, ...}} descriptionсинтаксис и попробовал: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an …

156 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

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

119 javascript  google-closure-compiler  jsdoc 

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

105 javascript  documentation  jsdoc 

У меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Как лучше всего задокументировать то же самое? Следует ли определять shapeType как enum, TypeDef или что-то еще? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... …

96 google-closure-compiler  google-closure  jsdoc  code-documentation 

Раньше я всегда документировал параметры своего объекта следующим образом: /** * 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 { foo, bar } = …

89 arguments  ecmascript-6  jsdoc  destructuring 

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

84 javascript  node.js  documentation  jsdoc  promise 

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

84 javascript  jsdoc 

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

81 javascript  ide  jsdoc 

У меня есть функция в стиле ES6, которая определяется с помощью композиции функций с asyncPipe. import { getItemAsync } from 'expo-secure-store'; const asyncPipe = (...fns) => x => fns.reduce(async (y, f) => f(await y), x); const getToken = () => getItemAsync('token'); const liftedGetToken = async ({ ...rest }) => ({ …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc