Создание документации Javascript

Я просматриваю документ, который мы разрабатываем, и вы ищете хорошие генераторы документации javascript, есть ли у кого-нибудь предложения?

Мы использовали ndoc для создания документации для нашего кода С# и искали что-то похожее на документ нашего js-кода - в идеале что-то, что можно запустить из командной строки.

заблаговременно!

Ответы

Ответ 1

Для этого вы можете использовать известный JSDoc-Toolkit.

JsDoc Toolkit - это приложение, написанное на JavaScript, для автоматически генерируя многоформатный HTML-формат (или XML, JSON или любая другая текстовая) документация с комментариями JavaScript исходный код.

И да, он также имеет параметры командной строки.

Ответ 2

JSDoc - это подход к созданию документации из комментируемого JavaScript. Существует много вариантов:

  • Он был первоначально реализован в Perl.
  • JSDoc-Toolkit портировал его на JavaScript, но требует Java, поскольку использует механизм JavaScript Rhino, написанный на Java.
  • Несколько человек портировали его для запуска непосредственно на node.js механизм/платформа JavaScript, например. node-jsdoc-toolkit.
  • dox также работает на node.js, он объединяет JSDoc-подобные теги и разметку разметки, но требует отдельного механизма шаблонов (как используется для и github).

Все запускаются из командной строки. Выберите в соответствии с вашими настройками оснастки. Мне нравится node.js для его скорости и все-JavaScript-все время. DailyJS "Let Make a Framework" сообщение о написании документации описывает эти и другие инструменты; к сожалению, dox был радикально переработан, чтобы просто выводить структуры JSON, так как это было написано.

https://stackoverflow.com/q/1221413/1162195 упоминает другие генераторы документации JavaScript.