Merge pull request #127 from mishengqiang/master

声明文件文档的修改
This commit is contained in:
Patrick Zhong 2016-10-07 09:34:48 +08:00 committed by GitHub
commit d2f7d50d1e
6 changed files with 36 additions and 36 deletions

View File

@ -50,12 +50,12 @@ TypeScript是JavaScript的超集并且能够编译输出为纯粹的JavaScript.
* [混入](./doc/handbook/Mixins.md)
* [三斜线指令](./doc/handbook/Triple-Slash Directives.md)
* [如何书写声明文件](./doc/handbook/declaration files/Introduction.md)
* [库的结构](./doc/handbook/declaration files/Library Structures.md)
* [该做什么与不该做什么](./doc/handbook/declaration files/Do's and Don'ts.md)
* [由例子入手](./doc/handbook/declaration files/By Example.md)
* [深入探究](./doc/handbook/declaration files/Deep Dive.md)
* [发布到npm](./doc/handbook/declaration files/Publishing.md)
* [查找安装与使用](./doc/handbook/declaration files/Consumption.md)
* [结构](./doc/handbook/declaration files/Library Structures.md)
* [规范](./doc/handbook/declaration files/Do's and Don'ts.md)
* [举例](./doc/handbook/declaration files/By Example.md)
* [深入](./doc/handbook/declaration files/Deep Dive.md)
* [发布](./doc/handbook/declaration files/Publishing.md)
* [使用](./doc/handbook/declaration files/Consumption.md)
* [工程配置](./doc/handbook/README.md)
* [tsconfig.json](./doc/handbook/tsconfig.json.md)
* [NPM包的类型](./doc/handbook/Typings for NPM Packages.md)

View File

@ -39,12 +39,12 @@
* [混入](./doc/handbook/Mixins.md)
* [三斜线指令](./doc/handbook/Triple-Slash Directives.md)
* [如何书写声明文件](./doc/handbook/declaration files/Introduction.md)
* [库的结构](./doc/handbook/declaration files/Library Structures.md)
* [该做什么与不该做什么](./doc/handbook/declaration files/Do's and Don'ts.md)
* [由例子入手](./doc/handbook/declaration files/By Example.md)
* [深入探究](./doc/handbook/declaration files/Deep Dive.md)
* [发布到npm](./doc/handbook/declaration files/Publishing.md)
* [查找安装与使用](./doc/handbook/declaration files/Consumption.md)
* [结构](./doc/handbook/declaration files/Library Structures.md)
* [规范](./doc/handbook/declaration files/Do's and Don'ts.md)
* [举例](./doc/handbook/declaration files/By Example.md)
* [深入](./doc/handbook/declaration files/Deep Dive.md)
* [发布](./doc/handbook/declaration files/Publishing.md)
* [使用](./doc/handbook/declaration files/Consumption.md)
* 工程配置
* [tsconfig.json](./doc/handbook/tsconfig.json.md)
* [NPM包的类型](./doc/handbook/Typings for NPM Packages.md)

View File

@ -11,9 +11,9 @@
* [带属性的对象](#objects-with-properties)
* [函数重载](#overloaded-functions)
* [可重用类型(接口)](#reusable-types-interfaces)
* [Reusable Types (Type Aliases)](#reusable-types-type-aliases)
* [Organizing Types](#organizing-types)
* [Classes](#classes)
* [可重用类型(类型别名)](#reusable-types-type-aliases)
* [组织类型](#organizing-types)
* [](#classes)
# 例子
@ -141,7 +141,7 @@ interface GreetingSettings {
declare function greet(setting: GreetingSettings): void;
```
## 可重用类型(类型别名)
## <a name="reusable-types-type-aliases"></a>可重用类型(类型别名)
*文档*
@ -170,7 +170,7 @@ type GreetingLike = string | (() => string) | Greeting;
declare function greet(g: GreetingLike): void;
```
## 组织类型
## <a name="organizing-types"></a>组织类型
*文档*
@ -218,7 +218,7 @@ declare namespace GreetingLib.Options {
}
```
## 类
## <a name="classes"></a>
*文档*

View File

@ -8,41 +8,41 @@
这篇指南被分成了以下章节。
## 库的结构
## 结构
[库的结构](./Library Structures.md)一节将帮助你了解常见库的格式以及如何为每种格式书写正确的声明文件。
[结构](./Library Structures.md)一节将帮助你了解常见库的格式以及如何为每种格式书写正确的声明文件。
如果你在编辑一个已经存在的文件,那么你可能不需要阅读此章节。
如果你在书写新的声明文件,那么你必须阅读此章节以理解库的不同格式是如何影响声明文件的书写的。
## 该做什么与不该做什么
## 规范
声明文件里有很多常见的错误是很容易避免的。
[该做什么和不该做什么](./Do's and Don'ts.md)小节指出了常见的错误,
[规范](./Do's and Don'ts.md)一节指出了常见的错误,
描述了如何发现它们,
与怎样去修复。
每个人都要阅读这个章节以了解如何避免常见错误。
## 由例子入手
## 举例
很多时候,我们只能通过一些示例来了解第三方库是如何工作的,同时我们需要为这样的库书写声明文件。
[由例子入手](./By Example.md)这节展示了很多常见的API模式以及如何为它们书写声明文件。
[举例](./By Example.md)一节展示了很多常见的API模式以及如何为它们书写声明文件。
这篇指南是针对TypeScript初学者的它们可能还不了解TypeScript里的所有语言结构。
## 深入探究
## 深入
对于那些对声明文件底层工作机制感兴趣的老手们,
[深入探究](./Deep Dive.md)小节解释了很多高级书写声明文件的高级概念,
[深入](./Deep Dive.md)一节解释了很多高级书写声明文件的高级概念,
以及展示了如何利用这些概念来创建整洁和直观的声明文件。
## 模版
在[模版](./Templates.md)一节里,你能找到一些声明文件,它们可以帮助你快速开始
当你在书写一个新声明文件的时候。
参考[库的结构](./Library Structures.md)这篇文档来找到应该使用哪个模版文件。
参考[结构](./Library Structures.md)这篇文档来找到应该使用哪个模版文件。
## 发布到npm
[发布](./Publishing.md)一节讲解了如何发布声明文件为npm包及如何管理包的依赖。
[发布](./Publishing.md)一节讲解了如何发布声明文件为npm包及如何管理包的依赖。
## 查找与安装声明文件

View File

@ -1,8 +1,8 @@
# 概述
一般来讲,你*组织*声明文件的方式取决于库是如何被使用的。
在JavaScript里提供了很多库的使用方法,这就需要你书写声明文件去匹配它们。
这篇指南涵盖了如何识别常见库的模式,与怎么样书写符合相应模式的声明文件。
在JavaScript中一个库有很多使用方式,这就需要你书写声明文件去匹配它们。
这篇指南涵盖了如何识别常见库的模式,和怎样书写符合相应模式的声明文件。
针对每种主要的库的组织模式,在[模版](./Templates.md)一节都有对应的文件。
你可以利用它们帮助你快速上手。

View File

@ -62,12 +62,12 @@ TypeScript目前还在积极的开发完善之中不断地会有新的特性
* [混入](./doc/handbook/Mixins.html)
* [三斜线指令](./doc/handbook/Triple-Slash Directives.html)
* [如何书写声明文件](./doc/handbook/declaration files/Introduction.html)
* [库的结构](./doc/handbook/declaration files/Library Structures.html)
* [该做什么与不该做什么](./doc/handbook/declaration files/Do's and Don'ts.html)
* [由例子入手](./doc/handbook/declaration files/By Example.html)
* [深入探究](./doc/handbook/declaration files/Deep Dive.html)
* [发布到npm](./doc/handbook/declaration files/Publishing.html)
* [查找安装与使用](./doc/handbook/declaration files/Consumption.html)
* [结构](./doc/handbook/declaration files/Library Structures.html)
* [规范](./doc/handbook/declaration files/Do's and Don'ts.html)
* [举例](./doc/handbook/declaration files/By Example.html)
* [深入](./doc/handbook/declaration files/Deep Dive.html)
* [发布](./doc/handbook/declaration files/Publishing.html)
* [使用](./doc/handbook/declaration files/Consumption.html)
* [工程配置](./doc/handbook/README.html)
* [tsconfig.json](./doc/handbook/tsconfig.json.html)
* [NPM包的类型](./doc/handbook/Typings for NPM Packages.html)