Resultados de la búsqueda a petición "jsdoc"
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 ...
¿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 forzar nuevas líneas en las descripciones jsdoc de Google Apps
No puedo entender cómo en un script de Google Apps mostrar esto correctamente. Lo necesito para mostrar nuevas líneas en la salida de jsdoc (por ejemplo, cuando aparece la ventana de información sobre herramientas de funciones en una hoja de ...
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 * ...
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 ...
¿Cómo JsDoc un tipo "mixto"?
Pregunta simple, ¿cómo documento ese "tipo mixto"? Sé que podría enumerar todos los tipos posibles como{null|undefined|String|Number|Object} y termino encontrándome perdiendo uno y haciéndolo demasiado complejo. Intenté usar la palabra clave ...
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 ...
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 ...
Función sobrecargada de documentos en JSDoc
Tengo un sobrecargadopalancafunción y desea documentar los comportamientos con JSDoc. Si se define el valor, el estado de la ventana se establece en el valor booleano del parámetro verdadero, si no está definido, el estado de la ventana ...
JSDoc: ¿Cómo documento el literal de objeto "opciones" para una "clase" primaria? [duplicar
Esta pregunta ya tiene una respuesta aquí: ¿Cómo describir los argumentos de "objeto" en jsdoc? [/questions/6460604/how-to-describe-object-arguments-in-jsdoc] 5 respuestas Estoy usando jQuery's$.widget() base "clase" que proporciona unaoption() ...