web-dev-qa-db-fra.com

types de paramètres valides jsdoc

Existe-t-il une liste quelque part de types valides pour les balises param pour jsdoc? Par exemple,

@param {type} myParam Some parameter description

Je sais que des choses comme number et String sont valides, mais que faire si je veux documenter que le nombre est un entier. int est-il valide?

J'ai fait quelques recherches sur Google, mais je n'arrive pas à trouver une liste complète.

javascriptjsdoc
43
Jeff Storey

L'outil de documentation JS que j'ai utilisé vient de toute façon tokeniser les commentaires en chaînes, ce qui permet de mettre tout ce que vous voulez dans la section {type}.

Vous pouvez vous en tenir aux types JavaScript si vous voulez comme {nombre} ou {chaîne}, ou si vous voulez spécifier que vous pouvez faire {entier} ... mais je recommanderais probablement quelque chose comme:

@param {number} myParam must be an integer

à votre santé

28
hunterloftis

Pour répondre à la vraie question

Existe-t-il une liste quelque part de types valides pour les balises param pour jsdoc?

La documentation de @param indique ici que vous pouvez utiliser les types intégrés et " chemins de nom " (par exemple les chemins vers les types que vous avez créés/documentés précédemment et vos propres types que vous avez déclarés avec @type.

Si vous recherchez built-in Javascript types, vous obtenez ce qui suit, par exemple ici , vous obtenez la liste des types primitifs:

  • Booléen
  • Nul
  • Undefined
  • Nombre
  • Chaîne
  • Symbole (nouveau dans ECMAScript 2015)
  • Objet

Et voici quelques exemples de chemins de noms:

  • exempleFonction
  • exampleClass # someInstanceMember
  • exampleClass.staticMember
  • exampleClass ~ innerMember

Par exemple. @param {exampleClass} exampleParam Instance of your example class

14
Gyuri