Comment retourner void dans JsDoc ?

Question

Existe-t-il un moyen spécifié de déclarer une méthode ou une fonction pour retourner void dans JsDoc ? Actuellement, je pense que void est la valeur de retour par défaut et que d'autres valeurs de retour doivent être spécifiquement fournies :

 /**
 * @return {Integer} The identifier for ...
 */

Answer 1

Je ne pense pas que vous ayez à choisir parmi un ensemble de types dans JsDoc... vous pouvez utiliser n'importe quel nom de type que vous souhaitez (les accolades indiquent qu'il s'agit d'un type), vous pouvez donc simplement faire :

 @return {Void}

Bien que cela soit probablement plus correct pour JavaScript :

 @return {undefined}

Answer 2

En regardant les documents ESlint qu'ils utilisent @returns {void}

Source : http://eslint.org/docs/rules/valid-jsdoc

Étant donné que je dois fournir un @returns pour que chaque fonction réussisse les tests afin de pousser le code pour certains projets, cela est requis dans mon cas.

Answer 3

Si vous devez dire à voix haute que rien n'est renvoyé, vous pouvez le dire dans la description de forme libre . Ceci est utile pour clarifier les situations où un utilisateur peut s'attendre à ce que quelque chose soit renvoyé. Bien sûr, un nom approprié de la fonction et des paramètres devrait à lui seul faire apparaître le type de retour attendu, mais cela n'est pas toujours possible.

 /**
 * This is a funny function. Returns nothing.
 * @param {string} a joke.
 */
var funny = function (joke) {
  console.log(joke);
};