一些框架和库的API文档是怎么生成的

Question

一些框架和库的API文档是怎么生成的？

最近要做一个sdk得api文档，不知道怎么搞，文档有快速入门，教程，还有具体得API文档，加起来有500篇以上的内容，不可能一个个手写吧。请问有没有人知道类似一些框架和库是怎么生成管理的，比如VUE，react这些官方文档是怎么做的，有没有具体的框架或库，还请提供个大致的思路。自己研究了半天没研究明白。

Answer 1

文档内容肯定是手写的

Answer 2

js库的文档一般都是自己写的，很少有使用注释自动生成。
java后端的文档一般都是通过注释或者log自动生成。

Answer 3

api的文档一般是写在代码注释中的,按照规定的格式写,然后通过相应的工具转换成文档.
其他教程之类,就要自己写了.当然,这些可以找现成的进行修改,没必要完全从头写,至少结构上不用自己重写

Answer 4

• 文档内容肯定是手写的，不管是注释、md 还是别的什么，都是手写
• 生成的网站这个过程是可以借助框架的，比如 jsdoc，tsdoc 等等
• 如果是带类型的语言，比如 typescript，不写任何内容的话，可以生成一个类型参考网站，不过比较生硬，仅供内部使用还是可以的，像快速入门、教程这种，还是手写，我一般就是直接建个 docs 文件夹目录，用 md 写

Answer 5

gitbook 了解一下。

Answer 6

JSDoc 介绍

Answer 7

Sphinx可以自动获取代码中的docstring注释，自动生成文档

Answer 8

目前用的是

http://apidocjs.com

Answer 9

使用gitbook 或者hexo写成那些文档的；可以访问下我github:https://github.com/Samdyddd