Preguntas etiquetadas con jsdoc

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Pero, ¿cómo describo cómo deben estructurarse los objetos de parámetros? Por ejemplo, debería ser algo como: { setting1 : 123, // (required, integer) …

316 javascript  jsdoc 

¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? Encontré la @return {{field1: type, field2: type, ...}} descriptionsintaxis y la probé: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

De acuerdo con la wiki de JSDoc para @param , puede indicar que un @param es opcional usando /** @param {String} [name] */ function getPerson(name) { } y puede indicar un parámetro en línea usando function getPerson(/**String*/ name) { } Y puedo combinarlos como el siguiente, que funciona bien. /** …

119 javascript  google-closure-compiler  jsdoc 

En JSDoc, la mejor documentación que puedo encontrar muestra cómo usar lo siguiente si tiene una matriz de un tipo específico (como una matriz de cadenas) como: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } ¿Cómo reemplazaría los siguientes signos de interrogación para …

105 javascript  documentation  jsdoc 

Tengo una función que acepta un parámetro de cadena. Este parámetro solo puede tener uno de los pocos valores posibles definidos. ¿Cuál es la mejor forma de documentar lo mismo? ¿Debe shapeType definirse como enum o TypeDef o algo más? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", …

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

Anteriormente, siempre he documentado los parámetros de mis objetos de la siguiente manera: /** * 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 { …

89 arguments  ecmascript-6  jsdoc  destructuring 

Digamos que tiene algo como lo siguiente: var someFunc = function() { // do something here with arguments } ¿Cómo documentaría correctamente que esta función puede tomar cualquier número de argumentos en JSDoc? Esta es mi mejor suposición, pero no estoy seguro de que sea correcta. /** * @param {Mixed} …

82 javascript  jsdoc 

¿Existe una forma específica de declarar un método o una función para devolver vacío en JsDoc? Actualmente, creo que voides el valor de retorno predeterminado y se deben proporcionar específicamente otros valores de retorno: /** * @return {Integer} The identifier for ... */

81 javascript  ide  jsdoc 

Tengo una función de estilo ES6 que se define usando la composición de funciones con 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