Документирование кода Javascript

Я разрабатываю сайт, который становится немного сложным, поэтому я начал документировать свой код.

Для PHP я использовал PHPDocumentor; в любом случае кажется, что любой другой инструмент (например, Doxygen) будет принимать те же теги.

Теперь я хочу задокументировать JS-сторону. Я вижу, по крайней мере, JSDoc и ScriptDoc (и, возможно, другие) существуют, и они принимают разные теги, поэтому я должен сделать выбор. Каков стандарт (если есть) для документирования кода Javascript?

И кроме того, как они используются? Кажется, ScriptDoc интегрирован в студию Aptana, так есть ли способ использовать его без IDE?

Ответ 1

Нет никакого "стандартного" способа документирования кода JavaScript.

Проект JSDoc больше неактивен, вы должны взглянуть на JsDoc Toolkit.

Есть и другие хорошие альтернативы, следующие проекты довольно хороши:

YUIDoc
PDoc

О ScriptDoc, я думаю, что он сосредоточился на включении функций Code Assist на Aptana, а не на создании файлов документации.

Ответ 2

Для документации JS нет подавляющего стандарта, но есть тенденции.

Docco используется многими популярными активными проектами JS, включая Backbone и Underscore. Это просто и имеет отличные примеры прямо на главной странице.

JSDoc Toolkit старше и менее популярен для новых проектов. На сайте JSDoc также отсутствуют примеры кода JSDoc. Он также требует Rhino, который может быть сложно установить в Windows по сравнению с NodeJS.