首页 > 代码库 > Node.js API —— About this Documentation（关于本文档）

Node.js API —— About this Documentation（关于本文档）

2024-07-25 20:31:50   216人阅读

// 说明
    Node API 版本为 v0.10.31。
    中文参考：http://nodeapi.ucdok.com/#/api/ 
    本段为博主注解。

目录

● 关于本文档
    ○ 稳定性指标
    ○ JSON 输出

关于本文档

    本文档的目的是既能从参考文档角度也能从概念概览角度综合地解释 Node.js API。每个小节描述了一个内建模块或较之上层的核心模块。
    如若合适，属性类型、方法参数和事件监听器的参数会详细地在主标题下面列出。
    每个 .html 文件都有一个与之一致的表示相同信息的以结构化方式呈现的 .json 文件。此特性为试验性质，并为 IDE 和其他希望对文档进行操作的工具提供便利。
    每个 .html 和 .json 文件都是基于 node 源文件目录树下的 doc/api 文件夹中 .markdown 这一一致的文件创建。本文档使用 tools/doc/generate.js 这一程序生成。HTML 模板位于 doc/template.html 。

稳定性指标

    通过本文档，你将了解每个小节的稳定性指标。Node.js API 仍在不断变化。当某些部分成熟时，它会比其他部分更可靠。另一些部分是经过证明的，并被大量依赖，它们几乎不可能被改变。其他的是新增的、试验性的或已知为有危险并会被重新设计。
    稳定性指标如下：

稳定性：0 - 反对
该特性为已经知道有问题，并且改变已在计划当中。不要依赖它。使用该特性会引起警告。且后向兼容不应该被期待。
稳定性：1 - 试验
该特性最近被引进，且可能在未来版本被改变或移除。可以使用并提供反馈。如果它适用一个对你很重要的使用场景，请告诉 node 核心团队。
稳定性：2 - 不稳定
API 处于稳固的过程当中，但还没有足够的实际场景测试来确保稳定。若有可能，后向兼容会被提供。
稳定性：3 - 稳定
API 已经被满意地证明，但底层代码的清理可能引起小幅的改变。后向兼容是被保证的。
稳定性：4 - API冻结
这些 API 已经在生产被大量测试并且不太可能被改变。
稳定性：5 - 锁定
除非发现严重的 bug ，这些代码将不会改变。请不要在这些地方建议任何改动，它们都将被忽略。

JSON 输出

稳定性：1 - 试验

    每个通过 markdown 生产的 HTML 文件都有一个有同样数据的一致的 JSON 文件。
    这一特性是在 node v0.6.12 新引进的。它是试验性质。

 

Node.js API —— About this Documentation（关于本文档）


联系
我们