← Back

jsdoc/check-syntax warning

Reports against Google Closure Compiler syntax.

Examples

❌  Incorrect

/**
 * @param {string=} foo
 */
function quux (foo) {

}
// Message: Syntax should not be Google Closure Compiler style.

✅  Correct

/**
 * @param {string} [foo]
 */
function quux1 (foo) {

}

/**
 *
 */
function quux2 (foo) {

}