# 三斜杠指令
三斜杠指令是包含单个 XML 标记的单行注释。注释的内容用作编译器指令。
三斜杠指令仅在其包含文件的顶部有效。三斜杠指令前只能有单行或多行注释,包括其他三斜杠指令。如果在语句或声明之后遇到它们,它们将被视为常规单行注释,并且没有特殊含义。
# /// <reference path="..." />
/// <reference path="..." />
指令是该组中最常见的。它用作文件之间依赖关系的声明。
三斜杠引用指示编译器在编译过程中包含其他文件。
当使用 out
或 outFile
时,它们还用作对输出进行排序的方法。预处理通过后,文件以与输入相同的顺序发送到输出文件位置。
# 预处理输入文件
编译器对输入文件执行预处理传递以解析所有三斜杠引用指令。在此过程中,会将其他文件添加到编译中。
该过程从一组根文件开始;这些是在命令行或 tsconfig.json
文件的 files
列表中指定的文件名。这些根文件按照指定的顺序进行预处理。在将文件添加到列表之前,会处理其中的所有三斜杠引用,并包括它们的目标。三斜杠引用以深度优先的方式解析,按照它们在文件中出现的顺序。
如果使用相对路径,则相对于包含文件解析三斜杠引用路径。
# 错误
引用不存在的文件是错误的。文件有一个对自身的三斜杠引用是错误的。
# 使用 --noResolve
如果指定了编译器标志 noResolve
,则忽略三斜杠引用;它们既不会导致添加新文件,也不会更改所提供文件的顺序。
# /// <reference types="..." />
与用作依赖声明的 /// <reference path="..." />
指令类似,/// <reference types="..." />
指令声明对包的依赖。
解析这些包名的过程类似于在 import
语句中解析模块名的过程。将三斜杠引用类型指令视为声明包的 import
的一种简单方法。
例如,在声明文件中包含 /// <reference types="node" />
表示该文件使用 @types/node/index.d.ts
中声明的名称;因此,这个包需要与声明文件一起包含在编译中。
仅当您手动创作 d.ts
文件时才使用这些指令。
对于编译时产生的声明文件,编译器会自动为你添加/// <reference types="..." />
;当且仅当生成的文件使用引用包中的任何声明时,才会在生成的声明文件中添加 /// <reference types="..." />
。
要在 .ts
文件中声明对 @types
包的依赖,请在命令行或 tsconfig.json
中使用 types
。有关详细信息,请参阅 在 tsconfig.json 文件中使用 @types、typeRoots 和 types
。
# /// <reference lib="..." />
该指令允许文件显式包含现有的内置 lib 文件。
内置 lib 文件的引用方式与 tsconfig.json 中的 lib
编译器选项相同(例如,使用 lib="es2015"
而不是 lib="lib.es2015.d.ts"
等)。
对于依赖内置类型的声明文件作者,例如建议使用 DOM API 或内置 JS 运行时构造函数,如 Symbol
或 Iterable
,三斜杠引用 lib 指令。以前这些 .d.ts 文件必须添加此类类型的前向/重复声明。
例如,将 /// <reference lib="es2017.string" />
添加到编译中的某个文件中,相当于使用 --lib es2017.string
进行编译。
/// <reference lib="es2017.string" />
"foo".padStart(4);
# /// <reference no-default-lib="true"/>
该指令将文件标记为默认库。您将在 lib.d.ts
及其不同变体的顶部看到此评论。
该指令指示编译器不在编译中包含默认库(即 lib.d.ts
)。这里的影响类似于在命令行中传递 noLib
。
另请注意,当传递 skipDefaultLibCheck
时,编译器只会跳过检查具有 /// <reference no-default-lib="true"/>
的文件。
# /// <amd-module />
默认情况下,AMD 模块是匿名生成的。当使用其他工具来处理生成的模块时,这可能会导致问题,例如捆绑器(例如 r.js
)。
amd-module
指令允许将可选模块名称传递给编译器:
# amdModule.ts
///<amd-module name="NamedModule"/>
export class C {}
作为调用 AMD define
的一部分,将导致为模块分配名称 NamedModule
:
# amdModule.js
define("NamedModule", ["require", "exports"], function (require, exports) {
var C = (function () {
function C() {}
return C;
})();
exports.C = C;
});
# /// <amd-dependency />
注意:此指令已被弃用。请改用
import "moduleName";
语句。
/// <amd-dependency path="x" />
通知编译器需要在生成的模块的 require 调用中注入非 TS 模块依赖项。
amd-dependency
指令也可以有一个可选的 name
属性;这允许为 amd 依赖项传递一个可选名称:
/// <amd-dependency path="legacy/moduleA" name="moduleA"/>
declare var moduleA: MyType;
moduleA.callStuff();
生成的JS代码:
define(["require", "exports", "legacy/moduleA"], function (
require,
exports,
moduleA
) {
moduleA.callStuff();
});