【中文翻译】Node.js v4.2.3官方文档(1) - 关于

关于

这篇文档的目标是从使用和概念的角度全面地解释Node.js API。每一节都描述了一个内建的模块或者高级的概念。

适当地在主题下面详细地列出了属性的类型、方法参数和事件处理器的参数。

每一个.html文档都有一个与之相对应的.json文档，这个.json文档以结构化的方式提供了与.html相同的内容。这个特性是试验性的，它对IDE和其他的（想要程序化处理一些事情的）工具提供了便捷。

每一个.html和.json文件都是基于源码中.markdown文件生成的，这些.markdown文件在源码的doc/api文件夹中。文档是由tools/doc/generate.js程序生成的。HTML模板位于doc/template.html。

Stability Index（稳定性标志）

贯穿整篇文档，你能看到每一个特性的稳定性标志。Node.js API或多或少地还在变化。一些特性被大量地证实是可靠的，因此几乎不可能变化。其他的则是全新的、试验性的、危险的和重新设计当中的。

稳定性标志有如下这些：

Stability: 0 - Deprecated

特性存在问题，并且计划修改。不要依赖这样的功能。使用它可能会引发警告。也不要妄想向后兼容了。

Stability: 1 - Experimental

特性很可能发生变化，and is gated by a command line flag.

在未来的版本中可能发生变化或者被移除。

Stability: 2 - Stable

已被证明是符合要求的。与NPM生态系统的兼容性是首要被考虑的，除非绝对的需要否则是不会变化的。

Stability: 3 - Locked

不要建议API去修改这部分特性，除非是修复漏洞或者与性能和安全相关的修改。

JSON Output

Stability: 1 - Experimental

每个在markdown中的HTML文档都有相应的JSON文档，这些JSON文档有着相同的数据。

这个特性是在node v0.6.12中加入的。它是试验性的。