什么相当于 sdk 的招摇?
Whats the equivalent of swagger for sdk's?
是否有某种标准供人们用来记录他们的库和框架?
理想情况下,它将使用 JSON 或 YAML,并允许生成 HTML 页面来很好地呈现它。
SDK 文档最常用的方法是根据源代码中的注释生成文档。这样 class/function 参考文档可以很容易地与实现保持同步。
有针对不同编程语言和框架的文档生成器。一些工具可让您将生成的参考文档与手动编写的概念主题(概述、"getting started" 等)结合起来
一些流行的工具是:
- .NET - Sandcastle
- Java - Javadoc(JDK 的一部分)
- Java脚本 - jsdoc
- Python - Sphinx, specifically sphinx-apidoc
- 示例:Python docs
- Doxygen 支持 C/C++, Objective-C, C#, Java, PHP 和一些其他语言
是否有某种标准供人们用来记录他们的库和框架?
理想情况下,它将使用 JSON 或 YAML,并允许生成 HTML 页面来很好地呈现它。
SDK 文档最常用的方法是根据源代码中的注释生成文档。这样 class/function 参考文档可以很容易地与实现保持同步。
有针对不同编程语言和框架的文档生成器。一些工具可让您将生成的参考文档与手动编写的概念主题(概述、"getting started" 等)结合起来
一些流行的工具是:
- .NET - Sandcastle
- Java - Javadoc(JDK 的一部分)
- Java脚本 - jsdoc
- Python - Sphinx, specifically sphinx-apidoc
- 示例:Python docs
- Doxygen 支持 C/C++, Objective-C, C#, Java, PHP 和一些其他语言