TypeScript学习笔记--三斜线指令

134 阅读2分钟

一、定义

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

二、放置的位置

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

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

三、解析的方式

三斜线引用以它们在文件里出现的顺序,使用深度优先的方式解析

四、路径引用

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

五、报错

引用不存在的文件会报错

一个文件用三斜线指令引用自己会报错

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

六、几种情况

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

用于声明文件间的依赖
三斜线引用告诉编译器在编译过程中要引入的额外的文件




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

用于声明了对某个包的依赖
包的名字的解析与在 import语句里对模块名的解析类似,
简单地可以把三斜线类型引用指令当做 import声明的包

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

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

在编译阶段生成的声明文件,编译器会自动地添加/// <reference types="..." />

当且仅当结果文件中使用了引用的包里的声明时才会在生成的声明文件里
添加/// <reference types="..." />语句



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

把一个文件标记成默认库

告诉编译器在编译过程中不要包含这个默认库(比如,lib.d.ts)。 
这与在命令行上使用 --noLib相似

在 lib.d.ts文件和它不同的变体的顶端看到这个注释



/// <amd-module name='NamedModule'/>

允许给编译器传入一个可选的模块名

默认情况下生成的AMD模块都是匿名的。 但是,当一些工具需要处理生成的模块时会产生问题

这会将NamedModule传入到AMD define函数里