37

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

  • should work with jquery, underscore and backbone. that means object-literal methods etc
  • I really like pdoc but its too centered around prototype, poorly documented, and I don't want to make extra files (sections?) to make it work (not sure about this)
  • docco is nice but I want structured output (as in menu + class/func structure like jdoc)
  • must be command line/makefile compatible (not web pastie)

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

Why Doesn't jQuery use JSDoc?

Community
  • 1
  • 1
clyfe
  • 23,695
  • 8
  • 85
  • 109

5 Answers5

5

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/

Gaurav Jassal
  • 912
  • 1
  • 6
  • 6
1

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.

SoWeLie
  • 1,381
  • 12
  • 16
1

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

Jasmine Hegman
  • 547
  • 7
  • 22
1

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.

Jacob Swartwood
  • 4,075
  • 1
  • 16
  • 17
-1

There is DocumentJS*

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

howtodothis
  • 1,265
  • 4
  • 17
  • 30