在JSDoc与WebStorm中如何正确标注布尔类型的可选参数？

问题根源 #

你的JSDoc注释将参数b声明为可选布尔类型（{boolean=}意味着仅允许boolean/undefined两种值），但代码逻辑中会给b赋值空字符串，类型不匹配才会触发WebStorm的类型校验警告。

可行解决方案 #

方案1：修正JSDoc类型声明（最推荐）

直接更新JSDoc标注，明确参数允许的类型为布尔值、字符串，和你的实际逻辑对齐即可消除警告：

/**
 * Prints true, false or empty string
 * @param {boolean|string=} b
 */
test = (b = '') => {
    console.log(`b = "${b}"`)
}

如果仅允许空字符串作为非布尔场景的取值，也可以写得更精准：@param {boolean|''=} b

方案2：不修改参数类型，调整输出逻辑

如果你希望保持参数b的类型仅为布尔/undefined，不需要修改参数本身，只在输出时做兼容处理即可：

/**
 * Prints true, false or empty string
 * @param {boolean=} b
 */
test = (b) => {
    const output = typeof b === 'boolean' ? b : ''
    console.log(`b = "${output}"`)
}

方案3：临时抑制该行警告（下策）

如果你确认逻辑无误、不想调整类型声明，可通过WebStorm专属的注释抑制当前行的类型校验警告：

/**
 * Prints true, false or empty string
 * @param {boolean=} b
 */
test = (b) => {
    // noinspection JSAssignTypeMismatch
    if (typeof b !== 'boolean') b = ''
    console.log(`b = "${b}"`)
}

内容的提问来源于stack exchange，提问作者Michael Hobbs