Есть ли способ создать документацию API Javascript, такую как Документация API библиотеки Google Closure?

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

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

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

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

http://closure-library.googlecode.com/svn/docs/namespace_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, для моего собственного источника (который будет открытым исходным кодом, если это имеет значение).

Спасибо заранее...

Ответ 1

Google Closure + JSDoc

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

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

ExtJS + Ext-Doc

Еще один, на который вы могли бы обратить внимание, и посмотреть, как они это делают, - это онлайн-документ для ExtJS. Мне сначала немного стыдно ориентироваться, но вы привыкаете к нему довольно быстро. Проект с открытым исходным кодом, Ext-Doc, создает документацию с похожим стилем, хотя теперь она немного устарела.

YUI Doc

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

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

Ответ 2

Проверьте YUI Doc.

Ответ 3

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

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

Ответ 4

Более новая опция http://documentation.js.org/, которая использует JSDoc и генерирует HTML:

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

Ответ 5

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

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