Triple-Slash Directives

三重指令 (Triple-Slash Directives)

三斜杠指令是包含单个 XML 标签的单行注释。注释的内容被用作编译器指令。

三斜杠指令仅在其包含文件的顶部有效。三斜杠指令只能在单行或多行注释之前，包括其他三斜杠指令。如果他们在声明或声明后遇到，他们将被视为常规单行注释，并且不具有特殊含义。

/// <reference path="..." />

/// <reference path="..." />指令是该组中最常见的。它用作文件之间依赖关系的声明。

三斜杠引用指示编译器在编译过程中包含其他文件。

它们也可用作在使用--out或者--outFile 时排序输出的方法。在预处理完成后，文件以与输入相同的顺序发送到输出文件位置。

预处理输入文件

编译器对输入文件执行预处理传递以解析所有三斜杠引用指令。在此过程中，其他文件将添加到编译中。

该过程从一组根文件开始 ; 这些是在命令行或tsconfig.json文件"files"列表中指定的文件名tsconfig.json。这些根文件按照它们指定的相同顺序进行预处理。在将文件添加到列表之前，会处理其中的所有三斜杠引用，并且包括它们的目标。按照它们在文件中看到的顺序，三斜杠引用以深度优先方式解决。

如果没有根据，则三斜杠引用路径相对于包含文件被解析。

错误

引用不存在的文件是错误的。这是一个文件有一个三斜杠参考本身的错误。

运用 --noResolve

如果--noResolve指定了编译器标志，则忽略三斜杠引用; 它们既不会导致添加新文件，也不会改变提供的文件的顺序。

/// <reference types="..." />

与/// <reference path="..." />指令类似，该指令用作依赖声明; 一/// <reference types="..." />，然而，声明上的依赖@types包。

/// <reference types="node" />在声明文件中包含声明此文件使用在@types/node/index.d.ts中声明的名称；因此，这个包需要和声明文件一起包含在编译中。

解析这些@types包名称的过程与在import语句中解析模块名称的过程类似。将三斜杠引用类型指令视为import用于声明包的简单方法。

只有在您d.ts手动创作文件时才使用这些指令。

对于编译过程中生成的声明文件，编译器会自动/// <reference types="..." />为你添加; 当且仅当生成的文件使用引用@types包中的任何声明时，才会/// <reference types="..." />添加生成的声明文件中的

为了声明.ts文件中的@types包的依赖关系，请使用--types命令行或tsconfig.json替代方法。请参阅使用@types，typeRoots和types在tsconfig.json文件中获取更多详细信息。

/// <reference no-default-lib="true"/>

该指令将文件标记为默认库。您会在顶部看到此评论lib.d.ts及其不同的变体。

该指令指示编译器在编译时不包含默认库（ie 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 {
}

作为调用 AMDdefine的一部分，将导致为该模块分配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" /> 通知编译器关于需要在结果模块的需求调用中注入的非 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()
}