CODEWITHSUNDEEP
javascriptdocumentation-generationxml-documentationvsdoc
Eskat0n
Eskat0n

Reputation: 937

Which comments documentation format is better for JavaScript?

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?

Upvotes: 6

Views: 3012

Answers (3)

Keith
Keith

Reputation: 155862

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.

Upvotes: 1

Matthew Crumley
Matthew Crumley

Reputation: 102755

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.

Upvotes: 1

Raynos
Raynos

Reputation: 169531

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

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

Upvotes: 9

Related Questions