PDA

View Full Version : JSDoc - how to generate dynamic documentation out of code



humpdi
13 Mar 2007, 10:01 AM
hey guys!

ive the requirement for my project that i have to build a documentation out of the code, dynamicly of course. did anybody knows a tool that do something like that?

e.g:

/**
* @class Ext.BasicDialog
* @extends Ext.util.Observable
* Lightweight Dialog Class.
* /


something like this should result a class documentation.

please share your expereance
:)

BernardChhun
13 Mar 2007, 2:48 PM
this one looks great : http://www.naturaldocs.org/

brian.moeskau
13 Mar 2007, 7:49 PM
Maybe I'm missing something, but have you tried JSDoc or not? You listed it in the post title, so not sure if you've tried it as it works fairly well. However, if you are specifically looking at some of the extended (non-JSDoc) attributes that Jack uses in his comments, those won't be supported anywhere since Jack wrote his own source parser to generate his comment files for total flexibility. He may release it at some point, but currently it is for internal use only.

NaturalDocs has some nice features (very expressive in terms of in-comment diagramming etc.), but the syntax is different from "standard" JavaDoc conventions and thus you're on your own if you head down that path.

humpdi
14 Mar 2007, 1:23 AM
ok, thanks a lot for your answers! i will look forward for this :)