Запитання з тегом «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, // …

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 …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Згідно з JSDoc вікі для @param, ви можете вказати, що @param є необов'язковим, використовуючи /** @param {String} [name] */ function getPerson(name) { } і ви можете вказати параметр, вбудований в параметр, використовуючи function getPerson(/**String*/ name) { } І я можу поєднати їх, як наступне, що добре працює. /** @param [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"... this.type …

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 

Скажімо, у вас є щось на зразок наступного: var someFunc = function() { // do something here with arguments } Як би ви правильно задокументували, що ця функція може приймати будь-яку кількість аргументів у JSDoc? Це моє найкраще здогадування, але я не впевнений, що це правильно. /** * @param {Mixed} …

85 javascript  jsdoc 

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

83 javascript  node.js  documentation  jsdoc  promise 

Чи є вказаний спосіб оголосити метод або функцію для повернення 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 }) => ({ token: …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc