Hi, I have some JavaScript to document and am not sure which tool is best to use - ideally I would like to publish the docs online but also have an offline browsable version. I know there are more tools about than jsdoc nowadays - any experiences of different doc tools for JavaScript would be useful. If it has a maven plugin that would be a bonus but not required.
+4
A:
Natural Docs is one option that can produce nicely formatted HTML documentation (example output), with at least basic support for JavaScript. Someone's also written a doxygen helper script to use that with JavaScript as well.
Amber
2009-08-03 09:34:17
Natural Docs requires PERL to work.
Marco Demajo
2010-06-02 11:52:00
+2
A:
JsDoc-Toolkit is also worth a look: http://code.google.com/p/jsdoc-toolkit/
Residuum
2009-08-03 09:40:55
A:
Slightly off topic for this, but related enough I feel to warrant an answer.
The vsdoc convention is useful for getting intellisense in Visual Studio.
The folllowing link is probably a good place to start:
James Wiseman
2009-08-03 10:29:12
+4
A:
I found some of my own after some research:
- JSDoc - the original Javadoc-style tool
- JSDoc Toolkit - a re-write by the original JSDoc author
- YUI Doc - the doc generation tool used by the YUI team
- Ext Doc - generates Ext-style API documentation
There is also a Maven JSTools Plugin that supports JSDoc Toolkit.
DLauer
2009-08-03 22:42:32
JSDoc requires PERL to work; YUI Doc requires PHYTON to work; Ext Doc creates heavy Ext-style documentation (not simpe, HTML/CSS documentation); JSDoc Toolkit works with JAVA;
Marco Demajo
2010-06-02 11:51:12