133 votes

Comment indiquer que param est optionnel si vous utilisez JSDoc en ligne?

Selon le JSDoc wiki pour @param , vous pouvez indiquer un @param est en option à l'aide de

/**
    @param {String} [name]
*/
function getPerson(name) {
}

et vous pouvez indiquer un param inline à l'aide de

function getPerson(/**String*/ name) {
}

Et je peux les combiner comme la suivante, ce qui fonctionne bien.

/**
    @param [name]
*/
function getPerson(/**String*/name) {
}

Mais je voudrais savoir si il existe un moyen de le faire en ligne si possible.

70voto

vvMINOvv Points 492

Après avoir creusé, j'ai trouvé que tout allait bien.

 /**
 * @param {MyClass|undefined}
 * @param {MyClass=}
 * @param {String} [accessLevel="author"] The user accessLevel is optional.
 * @param {String} [accessLevel] The user accessLevel is optional.
 */
 

Juste un peu plus attrayant que function test(/**String=*/arg) {}

54voto

studgeek Points 4617

J'ai trouvé un moyen de faire cela en utilisant des expressions de type Google Closure Compiler. Vous mettez un signe égal après le type, comme ceci: function test(/**String=*/arg) {}

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X