08-ts-三斜线指令

这是我参与更文挑战的第9天，活动详情查看： 更文挑战

---

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

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

若是三斜线指令出如今一个语句或声明以后，那么它们会被当作普通的单行注释，而且不具备特殊的涵义。

/// <reference path="..." />
/// <reference path="..." />指令是三斜线指令中最多见的一种。 它用于声明文件间的 依赖。
复制代码

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

预处理输入文件

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

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

一个三斜线引用路径是相对于包含它的文件的，若是不是根文件。

错误 引用不存在的文件会报错。 一个文件用三斜线指令引用本身会报错。

使用 --noResolve 若是指定了--noResolve编译选项，三斜线引用会被忽略；它们不会增长新文件，也不会改变给定文件的顺序。

/// <reference types="..." />
与 /// <reference path="..." />指令类似，这个指令是用来声明 依赖的；
一个 /// <reference types="..." />指令则声明了对某个包的依赖。
复制代码

对这些包的名字的解析与在 import语句里对模块名的解析相似。 能够简单地把三斜线类型引用指令当作 import声明的包。

例如，把 /// 引入到声明文件，代表这个文件使用了 @types/node/index.d.ts里面声明的名字； 而且，这个包须要在编译阶段与声明文件一块儿被包含进来。

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

对于那些在编译阶段生成的声明文件，编译器会自动地添加/// ； 当且仅当结果文件中使用了引用的包里的声明时才会在生成的声明文件里添加/// 语句。

若要在.ts文件里声明一个对@types包的依赖，使用--types命令行选项或在tsconfig.json里指定。 查看 在tsconfig.json里使用@types，typeRoots和types了解详情。

/// 这个指令把一个文件标记成默认库。 你会在 lib.d.ts文件和它不一样的变体的顶端看到这个注释。

这个指令告诉编译器在编译过程当中不要包含这个默认库（好比，lib.d.ts）。 这与在命令行上使用 --noLib类似。

还要注意，当传递了--skipDefaultLibCheck时，编译器只会忽略检查带有/// 的文件。

/// 默认状况下生成的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";语句代替。

/// 告诉编译器有一个非TypeScript模块依赖须要被注入，作为目标模块require调用的一部分。

amd-dependency指令也能够带一个可选的name属性；它容许咱们为amd-dependency传入一个可选名字：

/// declare var moduleA:MyType moduleA.callStuff() 生成的JavaScript代码：

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