Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Generating Javascript documentation [closed]

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.

like image 665
Fran Verona Avatar asked Apr 30 '11 11:04

Fran Verona


2 Answers

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.

like image 73
Raynos Avatar answered Sep 24 '22 22:09

Raynos


I found a great tutorial to create JS documentation using JSDoc. I hope it helps to someone who need it.

Create useful relevant Javascript documentation with JSDoc

This was exactly what I need. Thanks for your answers stackers.

like image 36
Fran Verona Avatar answered Sep 23 '22 22:09

Fran Verona