Resultados de la búsqueda a petición "jsdoc"
Documentando funciones de miembros con JSDoc
Tengo algo como esto:
Cómo documentar un tipo de cadena en jsdoc con valores posibles limitados
Estoy teniendo una función que acepta un parámetro de cadena. Este parámetro puede tener solo uno de los pocos valores posibles definidos. ¿Cuál es la mejor ...
¿Cómo JSDoc los métodos de un objeto anidado?
He estado tratando de usar JSDoc3 para generar documentación en un archivo, pero estoy teniendo algunas dificultades. El archivo (que es un módulo Require.js...
¿Cómo documentar un diccionario en JSDoc?
Teniendo el siguiente ejemplo:
Documente el parámetro de función desestructurada en JSDoc
Anteriormente, siempre he documentado mis parámetros de objeto de la siguiente manera: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value ...
Compilador de cierre de Google 100% escrito
¿Cómo puedo hacer que mi aplicación se escriba al 100% con respecto al compilador de cierre de Google? Ya etiqueté todo con comentarios de jsdoc. ¿Es posible obtener 100? Estoy en 64,6%
JSDoc typedef en un archivo separado
¿Puedo definir todos los tipos personalizados en un archivo separado (p. Ej.types.jsdoc), para que puedan reutilizarse en toda la aplicación? ¿Cuál es la forma correcta de hacerlo? /** * 2d coordinates. * @typedef {Object} Coordinates * ...
Forma correcta de documentar funciones de argumentos abiertos en JSDoc
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 ...