有没有什么工具可以快速生成带导航的HTML API文档
其实就是想平时记一些代码段,然后以此生成带导航的类似API的文档,方便以后查阅开发
不知道 doxygen 能否满足你的要求
javadoc phpdoc jsdoc pydoc……
几乎任何语言都有 <语言>doc 项目,可以从注释中生成各种格式的API文档
仔细一看,题主的“其实”后面和前面完完全全事两个不同的需求……前一半生成代码API文档的回答事上面那个。后一半的需求其实是snippet管理,以sublime为首的各种编辑器,mac下的dash乃至evernote都可以用,随个人习惯。HTML的snippet集用起来太不方便了吧……
用GitBook来写吧。虽然他们家编辑器建立章节时对中文有点小问题,但生成的效果还是不错的。https://www.gitbook.io/
sphinx
可以试试
官网 http://sphinx-doc.org/
中文版 http://start-up-python.readthedocs.org/en/latest/index.html
@朴灵 大大写的 doxmate,完全符合你要求。
生成文档只需要一行:
doxmate build
你可以看看这个例子,这是我用 doxmate 搭的个人 Wiki
如果这个还不够,可以选择: Daux.io
MarkPad编辑器
好多啊
我也来一个犀鸟
Swagger
Demo:
http://petstore.swagger.wordnik.com
)
https://github.com/gongwalker/ApiManager.git
如你所愿