Есть ли способ генерировать документацию API JavaScript API, таких как документация API библиотеки закрытия Google?

Question

Я пытаюсь найти инструмент, который генерирует HTML-документацию для моего исходного кода JavaScript.

Кто-нибудь знает, если инструмент, который Google использует для генерации интерфейса в следующих URL-адреса, является открытым исходным кодом? Могу ли я создать аналогичный вывод?

http://closure-library.googlecode.com/svn/docs/class_goog_proto2_serializer.html.

http://closure-library.googlecode.com/svn/docs/nameespace_goog_date.html.

http://closure-library.googlecode.com/svn/docs/nameespace_goog_events.html.

http://closure-library.googlecode.com/svn/docs/class_goog_gears_database.html.

http://closure-library.googlecode.com/svn/docs/class_goog_ui_datepicker.html.

Я в курсе http://code.google.com/p/jsdoc-toolkit/

Но я хотел бы знать, если конкретный генератор, который использует Google, доступно для меня для использования для моего собственного источника (который будет открытым исходным кодом, если это имеет значение).

Заранее спасибо...

Answer 1

Google Closure + JSDOC

Как вы упомянули себя в своем комментарии, они строят на JSDOC Toolkit. Чтобы добавить специальные аннотации, используемые компилятором замыкания для проверки типа и прочего, но это означает, что вы также можете просто использовать JSDOC в верхней части закрывающегося кода для создания вашей документации. Генерация выхода с желаемым внешним видом и чувствовать, тогда только вопрос написания собственного шаблона и стилей.

Инструменты закрытия Google являются открытым источником, за исключением некоторых битов, которые не раскрываются в данный момент. В любом случае, вы можете взглянуть на документацию и исходный код и посмотреть, что они используют для генерации Javadocs.

Extjs + ext-doc

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

YUI DOC.

Как упомянуто Мэтью Манела, YUI DOC также производит довольно хорошую онлайн документацию.

Мой совет будет пойти на JSDOC, так как он является стандартом де-факто для многих инструментов, и он отражает практику Java, но это действительно зависит от того, что вы хотите.

Answer 2

Проверить YUI DOC..

Answer 3

Для тех, которые используют extjs, https://github.com/senchalabs/jsduck. является удивительным.

Для тех, которые не используют extjs, но знакомы с Рубином, https://github.com/b-studios/doc.js. отлично.

Answer 4

Новее вариант http://documentation.js.org/ который использует JSDOC и генерирует HTML:

Вы можете запустить его с глотанием https://github.com/documentationjs/gulpp-documentation.

Answer 5

Досье в настоящее время (2016) используется для построения Документация библиотеки закрытия. Отказ Он является фантастическим инструментом, который построен на верхней части самого компилятора замыкания, поэтому он фактически читает всю информацию о типе с помощью компилятора, а затем выводит документацию вместо кода.

Есть еще некоторые вещи, которые работают о пользовательском интерфейсе документов. В настоящее время эта страница документов библиотеки закрытия выглядит довольно пустой - вы должны нажать на символ «меню гамбургера» в верхнем левом углу, чтобы начать.