Documentation 对于sdk';s

Documentation 对于sdk';s,documentation,swagger,Documentation,Swagger,是否有一种人们用来记录其库和框架的标准 理想情况下,它将使用JSON或YAML,并允许生成能够很好地呈现它的HTML页面。SDK文档最常见的方法是从源代码中的注释生成文档。这样,类/函数参考文档可以轻松地与实现保持同步 有用于不同编程语言和框架的文档生成器。一些工具允许您将生成的参考文档与手动编写的概念主题(概述,“入门”等)结合起来 一些流行工具包括: .NET- 例如: Java-(JDK的一部分) 例如: JavaScript- 例如: Python-,特别是 例如: 支

是否有一种人们用来记录其库和框架的标准


理想情况下,它将使用JSON或YAML,并允许生成能够很好地呈现它的HTML页面。

SDK文档最常见的方法是从源代码中的注释生成文档。这样,类/函数参考文档可以轻松地与实现保持同步

有用于不同编程语言和框架的文档生成器。一些工具允许您将生成的参考文档与手动编写的概念主题(概述,“入门”等)结合起来

一些流行工具包括:

  • .NET-
    • 例如:
  • Java-(JDK的一部分)
    • 例如:
  • JavaScript-
    • 例如:
  • Python-,特别是
    • 例如:
  • 支持C/C++、Objective-C、C#、Java、PHP和其他一些语言
相关:,