标签: documentation swagger
人们用它来记录他们的库和框架是否有某种标准?
理想情况下,它会使用JSON或YAML,并允许生成可以很好地呈现它的HTML页面。
答案 0 :(得分:1)
SDK文档最常用的方法是从源代码中的注释生成文档。这样,类/函数引用文档可以很容易地与实现保持同步。
有针对不同编程语言和框架的文档生成器。有些工具可以让您将生成的参考文档与手动编写的概念主题(概述,“入门”等)结合起来。
一些流行的工具是: