JS注解怎么做类型检查_ JS注解配合类型检查工具的使用方法_技术教程

使用JSDoc注解配合// @ts-check或jsconfig.json可在JavaScript中实现类型检查，提升代码质量。1. 通过JSDoc为变量、函数等添加类型提示；2. VS Code内置支持，可直接显示类型错误；3. 配置jsconfig.json启用全项目检查；4. 支持基础类型、数组、对象、函数及自定义类型别名，无需迁移TypeScript即可获得静态类型检查能力。

JS注解本身不会执行类型检查，它只是为类型检查工具提供提示信息。要在JavaScript中实现类型检查，需要结合像 Flow 或 TypeScript 这样的工具。其中，使用JS注解配合 JSDoc 是一种在原生JS中添加类型信息的常用方式，尤其适用于不想完全迁移到TypeScript的项目。

1. 使用JSDoc添加类型注解

JSDoc是一种在JavaScript代码中写文档注释的标准方式，同时也被许多类型检查工具和编辑器用来推断变量类型。

通过在注释中使用特定标签，可以为变量、函数参数、返回值等指定类型。

示例：

/\*\*
 \* 计算两个数的和
 \* @param {number} a - 第一个数字
 \* @param {number} b - 第二个数字
 \* @returns {number} 两数之和
 \*/
function add(a, b) {
  return a + b;
}

上面的注解告诉类型检查工具或IDE：a 和 b 应该是 number 类型，返回值也是 number。

2. 配合 VS Code 实现类型提示

Visual Studio Code 内置了对 JSDoc 类型注解的支持，无需额外配置即可获得一定程度的类型检查和智能提示。

只要在 JS 文件中正确书写 JSDoc 注解，VS Code 就能识别并提示类型错误。

例子：

// @ts-check
/**
* @param {string} name
*/
function greet(name) {
console.log("Hello " + name);
}
greet(123); // VS Code 会在此行报错：类型 'number' 不能赋给类型 'string'

注意：// @ts-check 是开启当前文件类型检查的指令，加上后 VS Code 会主动检查类型是否匹配。

3. 在项目中启用更严格的类型检查

如果希望在整个项目中启用基于 JSDoc 的类型检查，可以在项目根目录创建 jsconfig.json 文件进行配置。

jsconfig.json 示例：

{
  "compilerOptions": {
    "checkJs": true,
    "noEmit": true,
    "strict": true
  },
  "include": ["src/**/*"]
}

关键配置说明：

checkJs: true —— 启用对 .js 文件的类型检查
noEmit: true —— 不生成输出文件，仅用于检查
strict: true —— 开启严格模式，包括类型推断和错误检测

配置完成后，所有包含 JSDoc 注解的 JS 文件都会被检查，帮助发现潜在的类型问题。

4. 支持的 JSDoc 类型语法

JSDoc 支持多种类型表达式，常见用法包括：

@param {string} —— 参数为字符串
@param {Array} 或 @param {number[]} —— 数组类型
@param {Object} —— 对象类型
@param {{name: string, age: number}} —— 匿名对象结构
@param {(a: number) => boolean} —— 函数类型
@typedef —— 定义自定义类型别名

使用 @typedef 定义复杂类型：

/\*\*
 \* @typedef {Object} User
 \* @property {string} name
 \* @property {number} age
 \* @property {boolean} isActive
 \*/
/**
* @param {User} user
*/
function logUser(user) {
console.log(user.name);
}

基本上就这些。通过 JSDoc 注解 + // @ts-check 或 jsconfig.json，你可以在纯 JavaScript 项目中实现有效的类型检查，提升代码健壮性和可维护性，而无需引入 TypeScript 编译流程。