How do you document your JavaScript?

Question

Hi,

I need to document quite a lot of JavaScript and jQuery code. I'm interested in diagrams, rather than the written documentation.

I'm wondering if there is some sort of standard for modelling the JavaScript functions? My goal is to show visualy how different functions interact with each other.

Thank you

Edit: I have been trying DFDs and sequence diagrams, but it's working as well as I'd like it to. I have a choice of mapping the function calls to the processes in the DFD, but that makes the diagram too confusing and it's easier to go through a firebug jumping from one function to another.

Calling processes with differently to the function names means that after I read the diagram it won't be that easy to map it to the javascript... Will post few scerenshots in a bit.

Answer 1

There is no tool available for this but

According to me you can use UML >> Sequence diagram for this which is used in ood to show the flow between the function calls or you can use flow charts to show th flow.

Note : replace object name with your javascript file

Example of sequence diagram

Answer 2

Hi,

If i understand it correctly you need to make documentation for your project/product, right?

may be this could be useful for your need, MS Visio it is a documentation software which is used for creating data flow diagrams(DFD) etc.,

May be you could use this for modeling you javascript/jquery code.

as far as i know this is good for documentation.

try this out or search for similar things.

Hope helpful..

There is another like this that is Rational Rose.