求一个文档工具，jsdoc?
发布于 11 年前 作者 gastrodia 6466 次浏览 最后一次编辑是 8 年前

希望可以，方便生成文档，方便webstorm里面提示的的方案 如果函数的传入 传出是json,希望生成工具可以把这个传入json的结构表示出来

9 回复

最近在公司做后天管理的接口开发，目前最烦的就是写文档，同求一个文档生成工具。

Sphinx 挺不错的，可惜是 Python 写的。有 node 写的就好了。 https://pypi.python.org/pypi/Sphinx

gulp 和 grunt 都有文档生成插件 使用略复杂

yuidoc，我最近在用的，我个人觉得比jsdoc要好一些

使用代码注释生成文档…不怎么看好…

sphinx 蛮好的, 写完发到 readthedocs , 做个CNAME转发到自己域名

ASP.NET 现在就是用的这个 see http://aspnet.readthedocs.org/en/latest/ http://docs.asp.net/en/latest/

类似的gitbook 可以试试…

感觉markdown写作还是弱了些.

可以试试 fireball-x/firedoc 是我们内部基于yuidoc做的文档生成工具，增加了markdown的主题(https://github.com/fireball-x/firedoc/tree/master/docs)以及多语言、枚举、函数参数定义、模组方法等特性。

2

最近研究了几个 最后选了这个 http://apidocjs.com/

@xream 看了一下，挺好。mark 上了。

回到顶部