关于 ts-check-jsdoc-experiment
这项编码技能通过 `@ts-check` 和 JSDoc 为 JavaScript 添加 TypeScript 类型检查，无需转换文件，适合渐进迁移、试验和类型验证。
主要功能
- 01用 `@ts-check` 检查 JavaScript
- 02通过 JSDoc 注释添加类型
- 03逐步采用 TypeScript 检查
适用场景
- 01在 JavaScript 文件中试验 TypeScript
- 02逐步迁移 JavaScript 代码库
- 03用类型注释验证 JavaScript
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/ts-check-jsdoc-experiment确认已加载。
详细介绍
使用 @ts-check 和 JSDoc 尝试 TypeScript
概述
无需将 JavaScript 转换为 TypeScript，即可为 JavaScript 文件添加 TypeScript 类型检查。在 JS 文件顶部使用 @ts-check，并通过 JSDoc 注释添加类型。这样，你就可以逐步尝试 TypeScript，而无需一次性完成全部转换。
适用场景
- 尝试 TypeScript
- 逐步迁移 JavaScript
- 为 JS 文件添加类型
- 帮助团队学习 TypeScript
- 使用类型验证 JavaScript
铁律
使用 @ts-check 和 JSDoc 为 JavaScript 文件添加 TypeScript 类型检查，无需进行完整转换。
示例
// @ts-check
/**
* @param {string} name
* @param {number} age
* @returns {string}
*/
function greet(name, age) {
return `Hello ${name}, you are ${age}`;
}
greet('Alice', 30); // OK
greet('Alice', '30'); // Type error!
/** @type {string[]} */
const names = ['Alice', 'Bob'];
/** @typedef {{ x: number, y: number }} Point */
/** @type {Point} */
const point = { x: 1, y: 2 };
参考资料
- Dan Vanderkam 著，《Effective TypeScript》，第 2 版
- 条目 80：使用 @ts-check 和 JSDoc 尝试 TypeScript
评论
支持 Markdown