What format of documentation for comments is better for JavaScript?

Question

Is there any comment documentation format for JavaScript and a processor for this format that generates HTML documentation?

I am currently using VSDoc xml comments to provide IntelliSense help during development, but as I know, there is no documentation generator for such comments. So, as an alternative, my question may sound like this: is there any utility that translates VSDoc comments from JavaScript files to HTML?

Answer 1

You looked at automatically generated documentation from JavaDoc or VSDoc or JSDoc or something like that.

They are all ugly and unreadable.

Solution has two times

• annotate your code with docco
• Make your API documentation written.

There is a third option, which is to have us automatically create documentation if you can do this.

Answer 2

I used Natural Docs for several projects. The syntax is good for reading inline, but since it does not have “full language support” for JavaScript, you should be somewhat explicit about each function / constant / class / that you want to document.

Answer 3

There is a utility that parses Javascript files and outputs the same XML format NDoc and Sandcastle: AjaxDoc

This way you get VS intellisense from the same comments and can output any format you want.