JSDoc是J*aScript的文档注释标准，通过@param、@returns等标签描述函数参数、返回值类型及功能，提升代码可读性和IDE智能提示，常用于现代前端开发中辅助类型检查与协作。

JS注解并不是J*aScript语言本身的特性，不像J*a有@Deprecated这样的原生注解支持。但在现代前端开发中，我们通常所说的“JS注解”其实是通过JSDoc这种文档注释语法来实现的，用于描述函数、参数、返回值等信息，提升代码可读性和工具支持（如IDE智能提示、类型检查）。

什么是JSDoc注解

JSDoc是一种广泛使用的J*aScript文档标准，它使用特定格式的多行注释来为函数、变量、类等添加元信息。这些注解能被工具（如VS Code、WebStorm、TypeScript、ESLint）识别，帮助开发者理解代码。

基本结构如下：

/** * 函数说明 * @param {类型} 参数名 - 参数描述 * @returns {类型} 返回值描述 */

常见JSDoc标签在函数中的使用

以下是一些常用的JSDoc标签及其在函数上的应用示例：

• @param：描述函数参数的类型和含义
• @returns 或 @return：描述返回值
• @description：补充函数功能说明
• @example：提供使用示例
• @throws：说明可能抛出的异常
• @deprecated：标记函数已废弃

实际使用示例

下面是一个带完整JSDoc注解的函数示例：

/**

• 计算两个数的和
• @param {number} a - 第一个加数
• @param {number} b - 第二个加数
• @returns {number} 两数相加的结果
• @example
• add(2, 3) // 返回 5 */ function add(a, b) { return a + b; }

另一个更复杂的例子，包含类型对象和异常说明：

Tanka

具备AI长期记忆的下一代团队协作沟通工具

146 查看详情

/**

• 获取用户基本信息
• @param {Object} user - 用户对象
• @param {string} user.name - 用户姓名
• @param {number} user.age - 用户年龄
• @throws {Error} 当用户姓名为空时抛出错误
• @returns {string} 格式化的用户信息 */ function getUserInfo(user) { if (!user.name) { throw new Error('Name is required'); } return ${user.name} is ${user.age} years old.; }

配合TypeScript或工具使用效果更佳

如果你使用TypeScript，JSDoc可以与类型系统结合，在不写.ts文件的情况下提供类型提示。例如：

/**

• @typedef {Object} Config
• @property {string} url - 请求地址
• @property {number} timeout - 超时时间（毫秒） */

/**

• 发送请求
• @param {Config} config */ function request(config) { console.log(config.url); }

在VS Code中，调用request时就会有自动提示。

基本上就这些。JSDoc不是必须的，但合理使用能让团队协作更顺畅，代码更容易维护。不复杂但容易忽略。

以上就是JS注解怎么注释函数_ JS注解在函数上的使用方法与示例的详细内容，更多请关注其它相关文章！

# 服务端  # 做seo工资待遇怎么样  # 怎样做网站外链推广呢  # 营销渠道推广服务包括哪些  # 营销推广助理面试问题  # 小红书推广网站是哪个平台  # 正规seo优化郑重承诺  # 网站优化效果对比推荐图  # 易seo商城模板  # 网站页面标题如何优化  # 天门推广策划网站有哪些  # 会有  # 是一种  # 如果你  # 是一个  # js性能  # 抛出  # 如何使用  # 用它  # 文档  # 返回值  # 前端开  # 工具  # webstorm  # typescript  # 前端  # js  # java  # javascript  # js注解教程 

相关栏目： 【 科技资讯46185 】 【 网络学院92790 】

相关推荐： 使用 Pandas 高效处理 .dat 文件：数据清洗与数值计算实战  微信聊天记录怎么加密_微信聊天记录加密方法  如何使用Rector自动化升级旧代码_通过Composer安装和配置Rector进行代码重构  QQ邮箱网页版邮箱入口 QQ邮箱官方登录平台  将JSON对象数组转置为键值对列表的实用指南  Windows10怎么开启存储感知 Windows10系统设置自动清理临时文件释放C盘空间【教程】  搜狗浏览器如何使用密码生成器创建强密码 搜狗浏览器内置密码安全工具  CSS Flexbox如何实现多行排列_flex-wrap wrap自动换行显示  怎么去除衣服上的口红印_生活小妙招教你用酒精轻松擦除  实现分段式页面滚动导航：CSS与J*aScript教程  QQ邮箱稳定登录入口_QQ邮箱官方网站网页版使用  漫蛙官网正版漫画入口 漫蛙2官方网页登录地址  电脑屏幕颜色不舒服怎么办_Windows夜间模式与色彩校准教程【护眼技巧】  MAC怎么让Dock栏只显示当前运行的应用_MAC终端命令实现极简Dock栏  Pandas DataFrame：高效添加条件计算列  Win10如何清理注册表垃圾 Win10手动清理无效注册表【技巧】  机构：以往存储涨价周期小米利润率实际上有所改善 能转嫁给消费者等  斑马英语APP如何开启夜间护眼阅读_斑马英语APP夜间模式与低蓝光设置教程  excel怎么制作工资条 excel快速生成工资条的方法  Golang如何使用net/url解析URL_Golang URL解析与处理方法  使用 Pandas 高效处理 .dat 文件：字符清理与数据计算  CSS子选择器：如何区分并样式化嵌套列表的子层级  HTML空白字符处理机制：渲染、DOM与编码实践  css绝对定位元素脱离父容器怎么办_确保父元素position非static  在J*a中如何开发在线活动报名与管理系统_活动报名管理项目实战解析  如何高效处理PHP中的Excel数据导入导出？PortPHP/Spreadsheet助你轻松搞定！  印象笔记如何设提醒任务防漏执行_印象笔记设提醒任务防漏执行【任务提醒】  Composer的 "licenses" 命令如何帮助你遵守开源协议_检查项目依赖的许可证合规性  win11 arm版怎么安装 M1/M2 Mac虚拟机安装ARM win11的方法  Golang如何安装Swagger工具_GoSwagger文档生成环境  探索高级语言到C/C++的转译路径：以Go为例及内存管理策略  c++如何使用折叠表达式(Fold Expressions)_c++17可变参数模板新技巧  c++ 获取系统当前时间 c++时间戳获取方法  顺丰快递查单号物流信息 顺丰快递小程序查询入口  优化MinIO list_objects_v2 操作的性能瓶颈与最佳实践  怎样更改Windows系统的默认安装路径_避免C盘爆满的终极设置【技巧】  58动漫网在线官方网 58动漫网正版动漫入口网址  Spring Boot内嵌服务器与J*a EE全栈特性：选择与部署策略  PS5 Pro有点优势但不多！ 《燕云十六声》PS5平台与PC性能画面对比  Angular中单选按钮的正确使用与常见陷阱解析  KFC游戏互动怎么赢取优惠券_KFC线上游戏活动参与与优惠代码赢取教程  漫蛙Manwa2官网入口地址分享 漫蛙漫画PC版永久访问通道  QQ邮箱电脑版登录入口_QQ邮箱官方网站登录平台  AO3同人作品网入口 AO3搜索引擎官网永久地址  2026年CSGO开箱网站推荐 CSGO开箱平台精选  品牌机怎么重装系统 联想/戴尔/惠普笔记本恢复出厂系统教程  AO3最新入口2025公告_AO3中文官网合集  Fabric Mod开发：在1.19.3+版本中正确添加自定义物品并管理物品组  mysql密码锁定怎么解锁_mysql密码锁定解锁后修改密码步骤  深入理解Promise链：如何在catch后中断then的执行