一、说明

三斜线指令是包含单个 XML 标签的单行注释,注释的内容会作为编译器指令使用。

三斜线指令仅可放在包含它的文件的最顶端,一个三斜线指令的前面只能出现单行或多行注释,这包括了其他的三斜线指令。

如果它们出现在一个语句或者声明之后,那么它们会被当做普通的单行注释,并且没有特殊的涵义。

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

/// <reference path="..." /> 指令时三斜线指令中最常见的一种,它用于声明文件间的依赖

三斜线引用告诉编译器在编译过程中要引入额外的文件。

当使用 --out 或者 --outFile 的时候,它也可以作为调整输出内容顺序的一种方法,文件在输出文件内容中的位置已经过预处理后的输入顺序一致。

预处理输入文件

编译器会对输入文件进行预处理来解析所有的三斜线引用指令,在这个过程中,额外的文件会加到编译过程中。

这个过程会以一些根文件开始,它们是在命令行中指定的文件或者是在 tsconfig.js 中的 "files" 列表中的文件。这些根文件按指定的顺序进行预处理。在一个文件被加入列表前,它包含的所有三斜线引用都要被处理,还有它们包含的目标。三斜线引用以它们在文件里出现的顺序,使用深度优先的方式解析。

一个三斜线引用路径是如果不是根文件,则是相对于包含它的文件的。

错误

引用不存在的文件会报错,一个文件用三斜线指令应用自己会报错。

使用 --noResolve

如果制定了 --noResolve 编译选项,三斜线引用会被忽略,他们不会增加新文件,也不会改变给定文件的顺序。

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

/// <reference path="..."> 指令用来声明文件 依赖,而 /// <reference types="..."> 指令则声明了对某个包的依赖。

对这些包的名字的解析与在 import 语句里对模块名的解析类似,可以简单的吧三斜线类型应用指令当做 import 声明的包。

例如:把 /// <reference tyoes="node" /> 引入到声明文件,表明这个文件使用了 @types/node/index.d.ts 里面声明的名字,并且,这个包需要在编译阶段与声明文件一起被包含进来。

仅当在你需要写一个 d.ts 文件时才会使用这个指令

  • 对于那些依赖在编译阶段生成的声明文件,编译器会自动添加 /// <reference types="..." />
  • 当且仅当结果文件中使用了引用的包里的声明时才会生成的声明文件里添加 /// <reference types="..." />

如果要在 .ts 文件里声明一个对 @types 的依赖,使用 --types 命令行选项或在 tsconfig.json 里指定。

/// <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="NameModule" />
export class P{
}

这回将 NameModule 传入 AMD define 函数里:

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" /> 告诉编译器有一个非 TypeScript 模块依赖需要被注入,做为目标模块 require 调用的一部分。

amd-dependency 指令也可以带一个可选的 name属性;它允许我们为amd-dependency传入一个可选名字:

/// <amd-dependency path="legacy/moduleA" name="moduleA"/>`
declare var moduleA:MyType
moduleA.callStuff()

生成的JavaScript代码:

define(["require", "exports", "legacy/moduleA"], function (require, exports, moduleA) {
    moduleA.callStuff()
});