Generating Javascript documentation

javascript documentation
Fran Verona picture Fran Verona · Apr 30, 2011 · Viewed 44.8k times · Source

I'm looking for a way to generate documentation automatically from my Javascript project. Anyone know how can I do this?

As far as I know, there're some tools like JSDoc but I want to know your opinion, your best choice and why.

Thanks!

EDIT: just to be clear, I need something like JavaDOC or PHPDocumentor but to use with my Javascript source code.

Answer

Raynos picture Raynos · Apr 30, 2011

There are tools like Natural Docs to do this. I've personally used it in the past and this works fine with javascript.

There are also tools like docco to document source code.

In general auto generated documentation tends to be too restrictive and sometimes handmade API's like the jQuery API are easier to use.

Also documentation for dynamic languages is different from documentation on static languages. As API's are used differently and state exist in a more loose sense.

Related questions

Documentation for using JavaScript code inside a PDF file

Where can I find documentation on running JavaScript code inside a PDF? I've never added a JavaScript action inside a PDF document. However, I've done quite a bit of web development using JavaScript. I have a few questions to whoever …

Read More
How to specify an array of objects as a parameter or return value in JSDoc?

In JSDoc, the best documentation I can find shows to use the following if you have an array of a specific type (such as an array of strings) as: /** * @param {Array.<string>} myStrings All my awesome strings */ function …

Read More
Best way to document anonymous objects and functions with jsdoc

Edit: This is technically a 2 part question. I've chosen the best answer that covers the question in general and linked to the answer that handles the specific question. What is the best way to document anonymous objects and functions with …

Read More