三斜杠指令(Triple Slash Directive)
一句话解释
/// 指令是告诉 TypeScript 编译器的单行注释——用于类型引用和路径别名。
用大白话说
三斜杠指令是以 /// 开头的特殊注释,给 TypeScript 编译器指令。它们必须出现在文件顶部、任何代码之前。常见指令:1. /// <reference path="..." />——包含类型声明文件
/// <reference types="..." />——引用 @types 包/// <reference lib="..." />——包含内置库(es2020、dom)/// <amd-module name="..." />——命名 AMD 模块在现代 TypeScript 中,大多数被 tsconfig.json 设置(types、lib、paths)替代。三斜杠主要在 .d.ts 文件或旧构建系统中需要。
示例
typescript
/// <reference path="./types/custom.d.ts" />
/// <reference types="node" />
/// <reference lib="es2020" />
// Now we can use Node.js types and ES2020 features
const buf: Buffer = Buffer.from("hello");
const result: bigint = 1n + 2n;
// Modern alternative: tsconfig.json
// {
// "compilerOptions": {
// "types": ["node"],
// "lib": ["es2020", "dom"]
// }
// }/// 指令告诉编译器包含类型文件、@types 包或内置库。现代项目用 tsconfig.json 代替。
常见混淆
容易混淆的对象: 普通注释
关键区别: 普通注释(// 或 /* */)被编译器忽略。三斜杠指令(///)被编译器解析为指令。三斜杠必须在文件顶部,后跟类似 XML 的标签。
相关术语
相关资源
相关课程
- TypeScript 声明
三斜杠。
解读错误信息
用大白话解释常见错误——什么意思、为什么发生、如何修复。