TypeScript 三斜线指令

TypeScript 三斜线指令简介

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

三斜线指令位置规定

三斜线指令仅可放在包含它的文件的最顶端。一个三斜线指令的前面只能出现单行或多行注释,这包括其它的三斜线指令。如果它们出现在一个语句或声明之后,那么它们会被当做普通的单行注释,并且不具有特殊的涵义。

常用三斜线指令

/// <reference path="./node.d.ts" />
/// <reference types="node" />

path 类型声明的是对本地文件的依赖,包含路径信息。

types 类型声明的是对 node_modules/@types 文件夹下的类型的依赖,不包含路径信息。

常常在一个后缀名为 .d.ts 的声明文件中可以见到三斜线指令引入文件,在编译阶段,上例中被依赖文件 node.d.ts 将被包含进来,就像将被依赖文件的源码展开在依赖声明处一样。

使用 --noResolve

如果指定了--noResolve编译选项,三斜线引用会被忽略。