JQuery совместимый генератор документации JavaScript

Мне нужно выбрать генератор документации (аналогичный jdoc в java или rdoc в ruby) для моего проекта javascript, который (построен с помощью jquery, подчеркивания и магистрали)

Кандидаты:

Требования

  • должен работать с jquery, подчеркиванием и основой. это означает методы объектно-литерала и т.д.
  • Я действительно, как pdoc, но его слишком сосредоточен вокруг прототипа, плохо документирован, и я не хочу создавать дополнительные файлы (разделы?), чтобы заставить его работать (не уверен в этом)
  • docco хорош, но я хочу структурированный вывод (как в структуре menu + class/func, например jdoc).
  • должен быть совместим с командной строкой /makefile (не веб-пастикой)

Советы, трюки, учебники, истории успеха, советы, которые очень приветствуются.

Почему JQuery не использует JSDoc?

Ответы

Ответ 2

Вы также можете посмотреть Dox от TJ Holowaychuk; это вилка Docco, но добавляет поддержку синтаксиса jsDoc. Я лично считаю, что код jQuery часто поддается свободному стилю встроенной документации, такой как Docco, но сейчас я в той же ситуации пытаюсь решить, какую систему doc использовать.

Ответ 3

Сейчас я переживаю одно и то же упражнение, и из того, что я видел, YUI Doc является лучшим. Мне нравится, что вы можете запустить его в режиме "сервер" и просмотреть документацию по мере ее записи. Намного лучше, чем выполнять сборку каждый раз, когда вы меняете документацию. Кроме того, создаваемая документация очень легко читается и очень хорошо организована.

Ответ 4

Это новое, так что оно может не соответствовать вашим требованиям к выходу, но вы можете найти njsdoc интересный. В отличие от большинства JS-документов, он пытается создать документацию, выполнив код и исследуя стек, а не просто разбирая файлы для аннотаций.

https://bitbucket.org/nexj/njsdoc

Ответ 5

Существует DocumentJS *

* Я не использовал его, и я не уверен, насколько он будет интегрирован с Backbone.