Documenting Javascript code

Question

I'm developing a site which is growing a bit complex and so I started documenting my code.

For PHP I have used PHPDocumentor; in any case it seems that any other tool (such as Doxygen) would accept the same tags.

Now I want to document the JS side. I see at least JSDoc and ScriptDoc (and probably others) exist, and they accept different tags, so I should make a choice. What is the standard (if any) for documenting Javascript code?

And moreover, how are they used? It seems ScriptDoc is integrated in Aptana studio, so is there any way to use it without the IDE?

Answer 1

There is no really a "standard" way of documenting JavaScript code.

The JSDoc project is no longer active, you should give a look to JsDoc Toolkit.

There are other good alternatives, the following projects are pretty good:

• YUIDoc
• PDoc

About ScriptDoc, I think it's focused on enabling Code Assist features on Aptana, rather than to generate documentation files.