jQuery-совместимый генератор документации JavaScript - PullRequest
Новая
       29

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

36 голосов
/ 21 декабря 2010

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

Кандидаты:

Требования

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

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

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

Ответы [ 5 ]

5 голосов
/ 09 августа 2012

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

https://github.com/senchalabs/jsduck

Одна команда будет генерировать документы, подобные этой http://docs.sencha.com/touch/2-0/

1 голос
/ 30 ноября 2012

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

https://bitbucket.org/nexj/njsdoc

1 голос
/ 27 августа 2012

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

1 голос
/ 01 июля 2011

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

0 голосов
/ 27 июня 2011

Есть ДокументJS *

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

...