使用JSDoc标注可选参数需用方括号[]包裹参数名，如@param {type} [param] – 描述，支持默认值写法[param=default]，提升代码可读性与工具支持。
在JavaScript中，函数参数默认都是可选的，因为语言本身不会强制传参。但在使用JSDoc为代码添加类型注解时，明确标注哪些参数是可选的，能显著提升代码可读性和工具支持（如IDE智能提示、类型检查）。下面介绍如何用JSDoc正确标注JS函数中的可选参数。
使用JSDoc标注可选参数
JSDoc通过在参数名两边加上方括号 [] 来表示该参数是可选的。这是标准且广泛支持的写法。
语法格式：
@param {类型} [参数名] - 描述
示例：
/** * 发送通知 * @param {string} message - 要显示的消息内容 * @param {string} [level='info'] - 消息级别，可选，默认为 'info' * @param {number} [duration] - 显示时长（毫秒），可选 */function notify(message, level = 'info', duration) { console.log(`[${level}] ${message}`); if (duration) { setTimeout(() => console.log('通知已结束'), duration); }}
在这个例子中，level 和 duration 都被标记为可选参数。其中 level 还带有默认值，JSDoc中也可以直接写默认值说明。
带默认值的可选参数注解
如果参数在函数定义中有默认值，JSDoc依然建议用方括号包裹参数名，并可在描述中注明默认值，或直接在类型后写明。
更清晰的写法：
Vizard
AI驱动的视频编辑器
101 查看详情
/** * 计算折扣后价格 * @param {number} price - 原价 * @param {number} [discount=0.1] - 折扣比例，默认10% * @returns {number} 折后价格 */function calcPrice(price, discount = 0.1) { return price * (1 - discount);}
这里 [discount=0.1] 表示参数可选且默认值为 0.1，IDE和类型工具能据此提供更准确的提示。
可选参数与TypeScript风格对比
如果你使用TypeScript，语法会更简洁：在参数名后加 ?，如 name?: string。但在纯JS配合JSDoc时，应坚持使用方括号方式。
例如，等效写法：
TS: (name?: string) => voidJS + JSDoc: @param {string} [name]
两者语义一致，但JSDoc更适合在JavaScript项目中保持类型信息。
注意事项与最佳实践
为了确保注解有效，注意以下几点：
只有确实可以不传的参数才标注为可选有默认值的参数一定用 [param=default] 形式，增强可读性配合 @returns 和 @example 可进一步完善文档现代编辑器（如VS Code）能根据JSDoc实现自动补全和错误提示
基本上就这些。合理使用JSDoc标注可选参数，能让JS函数接口更清晰，团队协作更顺畅。
以上就是JS注解怎么标注可选参数_ JS函数可选参数的注解方式与示例的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/876339.html
微信扫一扫 
支付宝扫一扫 
