javascript - example - ¿Cómo indicar param es opcional usando JSDoc en línea?

jsdoc return

Question

De acuerdo con la wiki de JSDoc para @param , puedes indicar que @param es opcional usando

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

y puede indicar un param en inline usando

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

Y puedo combinarlos como el siguiente, que funciona bien.

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

Pero me gustaría saber si hay una manera de hacerlo todo en línea si es posible.

Answer 1

De la documentación oficial :

Parámetro opcional

Un parámetro opcional llamado foo.

@param {number} [foo]
// or:
@param {number=} foo

Un parámetro opcional foo con valor predeterminado 1.

@param {number} [foo=1]

Answer 2

Después de excavar descubrí que estos también están bien

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

Solo un poco más atractivo visualmente que la function test(/**String=*/arg) {}

Answer 3

Encontré una manera de hacer esto usando las expresiones de tipo de compilador de cierre de Google. Pones un signo igual después del tipo like so: function test(/**String=*/arg) {}