Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
依赖于 #45
经过刚刚和陈伟的讨论,Node SDK 不适合像 JavaScript SDK 一样从注释生成 API 文档,因为 Node SDK 提供的功能比较琐碎,提供的组件类型比较杂,所以初步打算用 Markdown 手工编写 API 文档。
在内容上主要介绍参数格式、一部分内部细节,大段描述性文字链接到官网文档。
我大体上打算使用 https://github.com/atom/atomdoc 的语法,这是一个基于 Markdown 的 JavaScript API 描述语言,可以被解析并生成 HTML 文件。