讲师中心 微信公众号
AI工具推荐 视频效率加速

JavaScript 中为带默认值的函数参数提供更精准的 JSDoc 类型注解

雨芳吖_6367

雨芳吖_6367

发布时间:2026-08-15 10:21:30

|

215人浏览过

|

来源于php中文网

原创

JavaScript 中为带默认值的函数参数提供更精准的 JSDoc 类型注解

在纯 JavaScript 项目中接入 TypeScript 类型检查时,仅依赖参数默认值(如 x = 5)会导致类型推断过于宽泛或不准确;需通过显式 JSDoc 注解明确参数类型,尤其适用于 Vuex getter 中的匿名函数等难以添加类型声明的场景。

在纯 javascript 项目中接入 typescript 类型检查时,仅依赖参数默认值(如 `x = 5`)会导致类型推断过于宽泛或不准确;需通过显式 jsdoc 注解明确参数类型,尤其适用于 vuex getter 中的匿名函数等难以添加类型声明的场景。

TypeScript 的 JavaScript 支持(通过 @ts-check 和 JSDoc)允许我们在不迁移至 .ts 文件的前提下获得强类型校验。但需注意:默认值仅影响类型推断的“后备路径”,而非类型契约。例如:

function doSomething(withProp = 5) {
  return parseInt(withProp); // ❌ TS2345: Argument of type 'number' is not assignable to parameter of type 'string'.
}

此处 TypeScript 推断 withProp 为 number | undefined(因 = 5 暗示可选且初始为数字),而 parseInt 仅接受 string,故报错——但这并非因为 withProp 必须 是 number,而是推断结果未体现其实际使用意图(即:它应被设计为可传入字符串或数字)。

✅ 正确做法是使用 JSDoc 显式声明参数类型,并支持联合类型与默认值语义:

/**
 * @param {string|number} [withProp=5] - 输入值,支持字符串或数字,默认为 5
 */
function doSomething(withProp = 5) {
  return parseInt(String(withProp), 10); // ✅ 安全转换
}

对于 Vuex getter 中嵌套的匿名函数(如 getters: { foo: (state) => (id = 1) => {...}}),同样适用:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载

立即学习“Java免费学习笔记(深入)”;

const store = new Vuex.Store({
  getters: {
    // 匿名函数内需显式标注参数类型
    itemById: (state) => {
      /** @param {string|number} [id=''] */
      return function(id = '') {
        return state.items.find(item => String(item.id) === String(id));
      };
    }
  }
});

⚠️ 注意事项:

  • @param {T} [name=default] 中的 [name=default] 表示该参数可选,且默认值为 default;类型 T 应覆盖所有合法输入(包括默认值的类型);
  • 避免仅依赖运行时默认值推断(如 x = 'hello' 不代表 x 只能是 string),始终以接口契约为准;
  • 对复杂逻辑,可配合 @typedef 提前定义复用类型,提升可维护性;
  • 确保编辑器启用 // @ts-check 或 jsconfig.json 中配置 "checkJs": true。

总结:在 JS + TS 类型检查的混合环境中,JSDoc 是唯一可靠、零侵入、符合工具链标准的类型标注方式。默认值是实现细节,类型注解才是接口契约——尤其在深层嵌套、无命名函数的场景下,一句精准的 @param 往往胜过整段类型守卫逻辑。

热门AI工具

更多
Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4366

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1089

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4264

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

860

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1756

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3145

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4093

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2640

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn