4.6 KiB
三斜线指令是包含单个XML标签的单行注释。 注释的内容会做为编译器指令使用。
三斜线指令仅可放在包含它的文件的最顶端。 一个三斜线指令的前面只能出现单行或多行注释，这包括其它的三斜线指令。 如果它们出现在一个语句或声明之后，那么它们会被当做普通的单行注释，并且不具有特殊的涵义。
/// <reference path="..." />
/// <reference path="..." />指令是三斜线指令中最常见的一种。
它用于声明文件间的依赖。
三斜线引用告诉编译器在编译过程中要引入的额外的文件。
当使用--out或--outFile时，它也可以做为调整输出内容顺序的一种方法。
文件在输出文件内容中的位置与经过预处理后的输入顺序一致。
预处理输入文件
编译器会对输入文件进行预处理来解析所有三斜线引用指令。 在这个过程中，额外的文件会加到编译过程中。
这个过程会以一些根文件开始；
它们是在命令行中指定的文件或是在tsconfig.json中的"files"列表里的文件。
这些根文件按指定的顺序进行预处理。
在一个文件被加入列表前，它包含的所有三斜线引用都要被处理，还有它们包含的目标。
三斜线引用以它们在文件里出现的顺序，使用深度优先的方式解析。
一个三斜线引用路径是相对于包含它的文件的，如果不是根文件。
错误
引用不存在的文件会报错。 一个文件用三斜线指令引用自己会报错。
使用 --noResolve
如果指定了--noResolve编译选项，三斜线引用会被忽略；它们不会增加新文件，也不会改变给定文件的顺序。
/// <reference types="..." />
与/// <reference path="..." />指令相似，这个指令是用来声明依赖的；
一个/// <reference path="..." />指令声明了对@types包的一个依赖。
在声明文件里包含/// <reference types="node" />，表明这个文件使用了@types/node/index.d.ts里面声明的名字；
并且，这个包要在编译阶段与声明文件一起被包含进来。
解析@types包的名字的过程与解析import语句里模块名的过程类似。
所以可以简单的把三斜线类型引用指令想像成针对包的import声明。
仅当在你需要写一个d.ts文件时才使用这个指令。
对于那些在编译阶段生成的声明文件，编译器会自动地添加/// <reference types="..." />；
当且仅当结果文件中使用了引用的@types包里的声明时才会在生成的声明文件里添加/// <reference types="..." />语句。
若要在.ts文件里声明一个对@types包的依赖，使用--types命令行选项或在tsconfig.json里指定。
查看在tsconfig.json里使用@types，typeRoots和types了解详情。
/// <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 {
}
这会将NamedModule传入到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()
});