Search code examples
javascriptgoogle-closure-compilerjsdoc

How to indicate param is optional using inline JSDoc?

According to the JSDoc wiki for @param you can indicate a @param is optional using 

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

and you can indicate a param inline using

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

And I can combine them like the following, which works ok.

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

But I would like to know if there is a way to do it all inline if possible.

Solution

  • I found a way to do this using Google Closure Compiler type expressions. You put an equals sign after the type like so: function test(/**String=*/arg) {}