Which comments documentation format is better for JavaScript?

Question

Is there are any comments documentation format for JavaScript and processor for this format which generates HTML documentation?

Currently I am using VSDoc xml comments for providing IntelliSense help at developing time, but as I know there is no documentation generator for such comments. So alternatively my question may sounds like: Is there are any utility which translates VSDoc comments from JavaScript files to HTML?

[docco](http://jashkenas.github.com/docco/) – Raynos Sep 24 '11 at 16:38 — Raynos, Sep 24 '11 at 16:38

score 9 · Accepted Answer · answered Sep 24 '11 at 16:40

Have you looked at auto generated documentation from JavaDoc or VSDoc or JSDoc or anything like that.

They are all ugly and un-readable.

The solution is two fold

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

There is a third option which is to revolutionize the way we do auto generated documentation, if you can then please do.

score 1 · Answer 2 · answered Sep 24 '11 at 19:27

1

I've used Natural Docs for a few projects. The syntax is nice for reading the inline, but since it doesn't have "full language support" for JavaScript, you have to be somewhat explicit about each function/constant/class/whatever you want to document.

answered Sep 24 '11 at 19:27

Matthew Crumley

101,441
24
103
129

score 1 · Answer 3 · answered Feb 22 '12 at 17:29

1

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

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

answered Feb 22 '12 at 17:29

Keith

150,284
78
298
434

Which comments documentation format is better for JavaScript?

3 Answers3