sdk的招摇相当于什么？ [英] Whats the equivalent of swagger for sdk's?

问题描述

人们是否使用某种标准来记录他们的库和框架？

Is there somewhat of a standard out there that people use to document their libraries and frameworks?

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

Ideally, it would make use of JSON or YAML and would allow for generation of HTML pages that present it nicely.

推荐答案

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

The most common approach to SDK documentation is to generate the docs from the comments in the source code. This way the class/function reference docs can be easily kept in sync with the implementation.

有用于不同编程语言和框架的文档生成器。某些工具可让您将生成的参考文档与手动编写的概念性主题相结合（概述，入门等）。

There are documentation generators for different programming languages and frameworks. Some tools let you combine the generated reference docs with manually written conceptual topics (overview, "getting started", etc.)

一些受欢迎的工具是：

• .NET-沙堡
  
  
  
  
  • 示例：沙堡文档
  
  
  • .NET - Sandcastle
    • Example: Sandcastle docs
    
    
    • 示例： Java API文档
    
    
    • Example: Java API docs
    
    
    • 示例： Adblo ck Plus JSDoc
    
    
    • Example: Adblock Plus JSDoc
    
    
    • 示例： Python文档
    
    
    • Example: Python docs

    这篇关于sdk的招摇相当于什么？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！