jsdoc validi tipi di parametri

Esiste una lista di tipi validi per i tag param per jsdoc? Ad esempio,jsdoc validi tipi di parametri

@param {type} myParam Some parameter description

so che cose come number e String sono validi, ma che cosa se voglio documentare che il numero è un numero intero. int valido?

Ho fatto qualche ricerca su google, ma non riesco a trovare una lista completa.

fonte

2013-01-02 Jeff Storey

Gli strumenti di documentazione JS che ho usato hanno semplicemente modificato i commenti in stringhe, consentendo di inserire tutto ciò che si desidera nella sezione {type}.

Si potrebbe attaccare con tipi JavaScript se si voleva come {numero}, oppure se si desidera specificare che si possa fare {integer} ... Io probabilmente raccomandare qualcosa di simile:

@param {Number} myParam must be an integer

applausi

fonte

2013-01-03 00:28:59 hunterloftis

Ho notato che gli strumenti generalmente si limitano a tokenizzare le stringhe, quindi non importa. Speravo solo che esistessero alcuni tipi standard di tipi. Il sistema di tipo javascript non sembra abbastanza espressivo (ad esempio, il numero non è molto specifico), ma ci sono opzioni come hai mostrato sopra. –

Uno può mettere qualcosa dentro {}, ma potrebbe essere bello sapere quali sono le convenzioni, no? Non c'è davvero nessuna lista? Come c'è una convenzione per la specificazione di un oggetto Prototype, o dovrebbe essere @param {Object} ...? – fraxture

Per il generatore JSDoc (https://github.com/jsdoc3/jsdoc), in http://usejsdoc.org/tags-param.html si dice, "Il tipo di parametro può essere un tipo predefinito JavaScript, tale come stringa o oggetto, o un nome-percorso JSDoc su un altro simbolo nel codice. " In caso di un simbolo nel codice, viene generato un collegamento alla sua definizione. Tuttavia, i tipi built-in continuano a essere visualizzati come stringhe, quindi non vi è alcuna reale differenza, ad es. tra '{string}' e '{String}'. Inoltre, ad esempio, PhpStorm li riconosce entrambi, ma si lamenta di '{array}' mentre accetta '{Array}'. –

jsdoc validi tipi di parametri

risposta

Problemi correlati