Perguntas com a marcação «jsdoc»

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Mas como descrevo como o objeto de parâmetros deve ser estruturado? Por exemplo, deve ser algo como: { setting1 : 123, // (required, …

316 javascript  jsdoc 

Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei a @return {{field1: type, field2: type, ...}} descriptionsintaxe e tentei: /** * 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 …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

De acordo com o wiki JSDoc para @param, você pode indicar que um @param é opcional usando /** @param {String} [name] */ function getPerson(name) { } e você pode indicar um parâmetro embutido usando function getPerson(/**String*/ name) { } E posso combiná-los da seguinte forma, o que funciona bem. /** …

119 javascript  google-closure-compiler  jsdoc 

No JSDoc, a melhor documentação que posso encontrar mostra como usar o seguinte se você tiver uma matriz de um tipo específico (como uma matriz de strings) como: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Como você substituiria os pontos de interrogação …

105 javascript  documentation  jsdoc 

Estou tendo uma função que aceita um parâmetro de string. Este parâmetro pode ter apenas um dos poucos valores possíveis definidos. Qual é a melhor maneira de documentar o mesmo? O shapeType deve ser definido como enum ou TypeDef ou algo mais? Shape.prototype.create = function (shapeType) { // shapeType can …

101 google-closure-compiler  google-closure  jsdoc  code-documentation 

Anteriormente, sempre documentei meus parâmetros de objeto da seguinte maneira: /** * 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 } …

90 arguments  ecmascript-6  jsdoc  destructuring 

Eu tenho uma função no estilo ES6 que é definida usando a composição de funções com 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