CODEWITHSUNDEEP
javascriptjquerydocumentation-generationjsdoc
clyfe
clyfe

Reputation: 23770

jQuery compatible JavaScript documentation generator

I need to choose a documentation generator (similar to jdoc in java or rdoc in ruby) for my javascript project that (built with jquery, underscore and backbone)

Candidates:

Requirements

Tips, tricks, tutorials, success stories, advice greatly welcomed.

Why Doesn't jQuery use JSDoc?

Upvotes: 37

Views: 8969

Answers (5)

Jasmine Hegman
Jasmine Hegman

Reputation: 545

This is new so it may not fit your output requirements, but you might find njsdoc interesting. Unlike most JS documenters it tries to build documentation by executing the code and investigating the stack rather than just parsing the files for annotations.

https://bitbucket.org/nexj/njsdoc

Upvotes: 1

SoWeLie
SoWeLie

Reputation: 1391

I am going through the same exercise at the moment, and from what I've seen YUI Doc is the best. I love the fact that you can run it in "server" mode and view the documentation as you write it. Much better than having to execute a build each time you change the documentation. Also, the documentation that is generated is very easy to read and very well organized.

Upvotes: 1

Gaurav Jassal
Gaurav Jassal

Reputation: 912

I would rate jsduck from Sencha on top. I have used it on many projects. Simple to use

https://github.com/senchalabs/jsduck

A single command will generate docs like this http://docs.sencha.com/touch/2-0/

Upvotes: 5

Jacob Swartwood
Jacob Swartwood

Reputation: 4075

You could also look at Dox by TJ Holowaychuk; it's a fork of Docco, but adds some jsDoc syntax support. I personally find that jQuery code often lends itself to looser style of inline documentation like Docco, but I'm currently in the same situation of trying to decide what doc system to use.

Upvotes: 1

howtodothis
howtodothis

Reputation: 1295

There is DocumentJS*

*I haven't used it and I am not sure how well it will integrate with Backbone.

Upvotes: -1

Related Questions