0

0

JS注解怎么标注可选参数_ JS函数可选参数的注解方式与示例

星夢妙者

星夢妙者

发布时间:2025-11-11 09:43:25

|

172人浏览过

|

来源于php中文网

原创

使用JSDoc标注可选参数需用方括号[]包裹参数名,如@param {type} [param] - 描述,支持默认值写法[param=default],提升代码可读性与工具支持。

js注解怎么标注可选参数_ js函数可选参数的注解方式与示例

在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);
  }
}
  

在这个例子中,levelduration 都被标记为可选参数。其中 level 还带有默认值,JSDoc中也可以直接写默认值说明。

带默认值的可选参数注解

如果参数在函数定义中有默认值,JSDoc依然建议用方括号包裹参数名,并可在描述中注明默认值,或直接在类型后写明。

更清晰的写法:

张佩琳网上服饰商城系统 开源版
张佩琳网上服饰商城系统 开源版

张佩琳网上服饰商城具有美观大方的界面,独特的模板更换技术,轻轻一按便可替换网站整个外观,配套如凡客、麦网、好乐买等知名品牌商城模板,让你的商城时刻走在最潮流商城前端;科学的栏目摆布,让顾客对商城商品一目了然,强大的商品展示页面,让客户简单操作便可了解到商品的外观、款式、材料等参数,商城智能记录所有顾客浏览的商品,智能筛选最受欢迎的商品向顾客推荐,让客户了解最多人关注、最多人购买、最多人评价的商品,

下载

/**
 * 计算折扣后价格
 * @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) => void
  • JS + JSDoc: @param {string} [name]

两者语义一致,但JSDoc更适合在JavaScript项目中保持类型信息。

注意事项与最佳实践

为了确保注解有效,注意以下几点:

  • 只有确实可以不传的参数才标注为可选
  • 有默认值的参数一定用 [param=default] 形式,增强可读性
  • 配合 @returns@example 可进一步完善文档
  • 现代编辑器(如VS Code)能根据JSDoc实现自动补全和错误提示

基本上就这些。合理使用JSDoc标注可选参数,能让JS函数接口更清晰,团队协作更顺畅。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

443

2023.08.02

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1100

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

189

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1525

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

18

2026.01.19

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

513

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

73

2026.01.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7.9万人学习

Django 教程
Django 教程

共28课时 | 3.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号