使用{Boolean}标注布尔类型，配合is/has/can前缀命名，可选参数用方括号并注明默认值，提升代码可读性与协作效率。

在javaScript中，虽然没有编译期类型检查，但在使用jsDoc进行代码注解时，明确标注参数类型能极大提升代码可读性和维护性。对于布尔类型参数，应使用标准的JSDoc语法清晰表达。

布尔类型的JSDoc标注方式

使用@param标签时，将布尔类型写作{boolean}（注意是美式拼写，不是Boolean首字母大写）。

示例：

/**
 * 检查用户是否具有权限
 * @param {String} userId – 用户ID
 * @param {boolean} isAdmin – 是否为管理员
 * @returns {boolean} 是否有访问权限
 */
function checkaccess(userId, isAdmin) {
  return isAdmin || userId.length > 0;
}

常见布尔参数的语义化命名建议

布尔参数容易引起调用歧义，因此命名要尽量自解释。

• 使用is前缀：如isLoading、isValid
• 使用has前缀：如hasPermission、hasItems
• 使用can前缀：如canEdit、canSubmit

避免使用flag这类模糊名称，如flag1或option。

英特尔AI工具

英特尔AI与机器学习解决方案

70

查看详情

可选布尔参数的标注方法

如果布尔参数是可选的，使用方括号包裹参数名，并可加上默认值说明。

示例：

/**
 * 显示模态框
 * @param {string} message – 提示信息
 * @param {boolean} [fullscreen=false] – 是否全屏显示
 */
function showModal(message, fullscreen = false) {
  // …
}

也可在描述中注明默认行为，帮助调用者理解。

基本上就这些。规范书写{boolean}类型注解，配合清晰的参数命名和必要的说明，能让团队协作更顺畅。不复杂但容易忽略细节。