Resultados de la búsqueda a petición "jsdoc3"
JSDoc: Estructura de objeto de retorno
¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? He encontrado el@return {{field1: type, field2: type, ...}} description sintaxis y lo probé: /** * Returns a coordinate from a given mouse or touch event * ...
Texto y contenido predeterminados de "Inicio" para JSDoc
Después de ejecutar una compilación / renderización JSDoc básica desde Node.js: jsdoc file1.js file2.jsMe sale un documento bien formateado usando la plantilla predeterminada dentro de un directorio "fuera". ¡Casi todo es como se esperaba! Pero ...
¿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...
jsdoc: descripción multilínea @property
Estoy documentando mi código usando jsdoc, hasta ahora todo bien, tengo un comentario como el siguiente ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property...y viene en documento ...
¿Cuál es la forma correcta de documentar devoluciones de llamada con jsdoc?
He pasado bastante tiempo buscando en Internet la mejor manera de documentar correctamente las devoluciones de llamada con jsdoc, pero desafortunadamente, todavía no he encontrado una excelente. Aquí está mi pregunta: Estoy escribiendo una ...
Cómo documentar una función devuelta por una función utilizando JSDoc
Estoy usando JSDoc para la documentación de parámetros. Está claro cómo documentar los tipos de parámetros paramany_prompts, pero ¿cuál es la forma correcta de documentar la función que devuelve? /** * @param {Number} - number of times to ...
Enum como tipo @param en JSDoc
¿Es posible usar una enumeración para el JSDoc@param tipo de declaración como en el siguiente ejemplo? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { }Si uso un IDE ...