SuperAPI AI 工具集

ts-check-jsdoc-experiment

编程与开发

查看项目

更新于 10-16 06:45

技能介绍

用途:在不把 JavaScript 文件转换为 TypeScript 的前提下,为 JS 文件加上 TypeScript 类型检查。做法是在 JS 文件顶部添加 // @ts-check,并用 JSDoc 注释声明类型,从而逐步试验类型系统,而不必一次性完成完整迁移。

主要能力:通过 @param、@returns、@type、@typedef 等 JSDoc 标注为函数参数、返回值和变量指定类型。示例:// @ts-check 开头后,用 /** @param {string} name / 等注释标注函数 greet(name, age),传入类型不匹配的参数(如把数字写成字符串 '30')会触发类型错误;用 /* @type {string[]} / 标注数组,用 /* @typedef {{ x: number, y: number }} Point */ 定义对象类型并标注变量。

适用场景:试验 TypeScript、渐进迁移 JavaScript、为 JS 文件添加类型、团队学习 TypeScript、用类型验证 JavaScript。

限制:资料未提供具体工具链配置、编辑器或构建集成方式、支持的文件范围与版本要求;示例仅展示 JSDoc 标注与类型错误提示,未说明检查如何运行。参考来源为《Effective TypeScript》第 2 版 Item 80。