2011-02-05 14 views
30

Pregunta simple, ¿cómo puedo documentar ese "tipo mixto"? Sé que podría enumerar todos los tipos posibles como {null|undefined|String|Number|Object} y terminar encontrándome perdiéndome y haciéndolo demasiado complejo. Intenté utilizar la palabra clave Mixed, pero aparece un error emergente en muchos IDEs, como WebStorm.¿Cómo se JsDoc un tipo "mixto"?

Respuesta

47

he encontrado la manera de hacerlo:

/** 
* @param {*} foo 
*/ 
function bar(foo) {} 
+2

¿Dónde encontraste eso? Mis resultados de búsqueda solo pueden verificar que esto funcione para el [compilador de cierre] (https://developers.google.com/closure/compiler/docs/js-for-compiler#types). ¿Es la sintaxis JSDoc "oficial"? –

+0

@RobinvanBaalen Echa un vistazo a * El tipo TODO * el último: https://developers.google.com/closure/compiler/docs/js-for-compiler?hl=de#types – yckart

+2

@yckart Como dije antes ; [JSDoc] (http://usejsdoc.org/)! = [Compilador de cierre] (http://developers.google.com/closure). –

1

Uso {}

No es un ejemplo de http://usejsdoc.org/tags-type.html:

un objeto llamado 'myObj' con propiedades ' a '(un número),' b '(una cadena ) y' c '(cualquier tipo).

{{a: number, b: string, c}} myObj 
// or: 
{Object} myObj 
{number} myObj.a 
{string} myObj.b 
{} myObj.c 
Cuestiones relacionadas