Генератор документации JavaScript, совместимый с jQuery

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

Кандидаты:

Требования

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

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


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


person clyfe    schedule 21.12.2010    source источник


Ответы (5)


Я бы поставил jsduck от Sencha на первое место. Я использовал его во многих проектах. Простой в использовании

https://github.com/senchalabs/jsduck

Одна команда создаст такие документы, как http://docs.sencha.com/touch/2-0/

person Gaurav Jassal    schedule 09.08.2012

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

person Jacob Swartwood    schedule 30.06.2011

В данный момент я занимаюсь тем же упражнением, и из того, что я видел, YUI Doc - лучший. Мне нравится тот факт, что вы можете запускать его в «серверном» режиме и просматривать документацию по мере ее написания. Гораздо лучше, чем выполнять сборку каждый раз, когда вы меняете документацию. Кроме того, созданная документация очень легко читается и очень хорошо организована.

person SoWeLie    schedule 27.08.2012

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

https://bitbucket.org/nexj/njsdoc

person Jasmine Hegman    schedule 29.11.2012

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

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

person howtodothis    schedule 27.06.2011