带有轻量级标记的Javascript API文档框架 [英] Javascript API documenting framework with lightweight mark-up

查看:95
本文介绍了带有轻量级标记的Javascript API文档框架的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我正在寻找一个Javascript API文档框架,其功能类似于JSDoc,但会在代码注释中使用易于重构的文本或markdown(不是html)

I'm seeking a Javascript API documenting framework with features similar to JSDoc, but would use easy-to-type restructured text or markdown in the code comments (not html)

奖金:将与Sphinx很好地融合。但是,我不想维护单独的文档,而是根据评论生成API文档。

Bonus: would integrate well with Sphinx. However, I don't want to maintain separate documentation, but generate API documentation from comments.

http://code.google.com/p/jsdoc-toolkit/

推荐答案

我终于找到了最适合任务的JSDuck:

I finally found JSDuck the most suitable for the task:

https://github.com/senchalabs/jsduck

这篇关于带有轻量级标记的Javascript API文档框架的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆