Brian Cherne schrieb: > The Java engineers at my company told me about Javadoc... I didn't > even think to look for JSDoc... but it's essentially the same. I > haven't needed to extract the Javadoc code into a MSWord document, but > I think such tools already exist. I'll ask around. The other day when > I gave Aptana a trial-run I was happily surprised to see it reading my > Javadoc comments into a tooltip when I paused while thinking "what > parameters does this function take again"... > > But the biggest benefit is just in having consistent commenting of > functions. For instance, the Javadoc for my plug-in will read > something like: Unfortuanetely, Javadoc is a bit limited for documenting jQuery plugins. For example, most plugins offer "options", that is, they accept a object whose properties are used to override any set defaults. How do you document all these options via Javadoc?
Among the rather incomplete tools to generate HTML from jQuerys inline docs is my little doc tool: http://jquery.bassistance.de/docTool/docTool.html You can download it to modify the XSL stylesheet to produce different output. It currently works only on Firefox and needs to run on a webserver. -- Jörn Zaefferer http://bassistance.de _______________________________________________ jQuery mailing list discuss@jquery.com http://jquery.com/discuss/
