问题
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)
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/
回答1:
I finally found JSDuck the most suitable for the task:
https://github.com/senchalabs/jsduck
回答2:
InvisibleJS supports markdown and a variety of other formats.
Also take a look at docco.
回答3:
JSDoc 3 now supports markdown by a plugin. You can configure markdown support by adding the line
"plugins": [ "plugins/markdown" ],
to your configuration JSON file.
Now, starting JSDoc with -c conf.json will enable markdown support.
回答4:
For those who still searching for a markdown plugin for jsdoc-toolkit, please have a look at plug-ins called 'smartdown' in the following links
https://github.com/sproutcore/docs
(More reference on syntax : http://guides.sproutcore.com/documentation_guidelines.html)
I tried it with sphinx through the following templates (jsdoc-toolkit-rst-template, jsdoc-for-sphinx), and it works flawlessly.
来源：https://stackoverflow.com/questions/7032161/javascript-api-documenting-framework-with-lightweight-mark-up