javascript - how - jsdoc tipos de param válidos

jsdoc typedef

Question

¿Hay alguna lista de tipos válidos para las etiquetas param para jsdoc? Por ejemplo,

@param {type} myParam Some parameter description

Sé que cosas como el number y la String son válidas, pero ¿qué pasa si quiero documentar que el número es un número entero? Es int valido?

He hecho un poco de googlear, pero parece que no puedo encontrar una lista completa.

Answer 1

La herramienta de documentación de JS que he usado simplemente tokeniza los comentarios en cadenas de todos modos, haciendo posible poner lo que quieras en la sección {type}.

Podría seguir con los tipos de JavaScript si quisiera como {Número}, o si desea especificar que podría hacer {entero} ... Probablemente recomendaría algo como:

@param {Number} myParam must be an integer

aclamaciones

Answer 2

Para responder a la pregunta actual

¿Hay alguna lista de tipos válidos para las etiquetas param para jsdoc?

La documentación de @param indica que puede usar tipos namepaths y " namepaths " (ak rutas a los tipos que ha creado / documentado anteriormente y sus propios tipos declarados con @type .

Si busca built-in Javascript types , obtiene lo siguiente, por ejemplo here , obtiene la lista de tipos primitivos:

• Booleano
• Nulo
• Indefinido
• Número
• Cuerda
• Símbolo (nuevo en ECMAScript 2015)
• Objeto

Y aquí hay algunos ejemplos de rutas de acceso:

• ejemploFunción
• exampleClass # someInstanceMember
• exampleClass.staticMember
• exampleClass ~ innerMember

Por ejemplo, @param {exampleClass} exampleParam Instance of your example class