Add documentation for triple-slash-reference-types directives. PR439

This commit is contained in:
zhongsp 2016-11-27 08:53:31 +08:00
parent 0dbcc3da08
commit c17b68bd7b
2 changed files with 20 additions and 1 deletions

View File

@ -37,6 +37,25 @@
如果指定了`--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`](./tsconfig.json.md#types-typeroots-and-types)了解详情。
## `/// <reference no-default-lib="true"/>`
这个指令把一个文件标记成*默认库*。

View File

@ -95,6 +95,7 @@ TypeScript目前还在积极的开发完善之中不断地会有新的特性
## 主要修改 (Latest 10 updates)
* 2016-11-27 新增章节:[使用`/// <reference types="..." />`](./doc/handbook/Triple-Slash Directives.html)
* 2016-11-23 新增章节:[变量声明 - 展开操作符](./doc/handbook/Variable Declarations.html)
* 2016-10-23 新增章节:[高级类型 - 可辨识联合Discriminated Unions](./doc/handbook/Advanced Types.html)
* 2016-10-07 新增章节:[从JavaScript迁移到TypeScript](./doc/handbook/tutorials/Migrating from JavaScript.html)
@ -104,7 +105,6 @@ TypeScript目前还在积极的开发完善之中不断地会有新的特性
* 2016-07-21 新增章节:[tsconfig.json文件里的include和exclude匹配](./doc/handbook/tsconfig.json.html)
* 2016-07-20 新增章节:[this参数](./doc/handbook/Functions.html)
* 2016-07-20 新增章节:[readonly属性](./doc/handbook/Interfaces.html)
* 2016-07-20 新增章节:[基本类型 - Null and Undefined](./doc/handbook/Basic Types.html)
## 相关链接