Вопрос по javascript, google-closure-library, documentation-generation, google-closure – Есть ли способ создания документации API Javascript, такой как Документация API библиотеки Google Closure?

30

Я пытаюсь найти инструмент, который генерирует документацию 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 для моего собственного источника (который будет открытым, если это имеет значение).

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

Нашел эту цитату: «Компилятор Google Closure использует систему документации JSDoc, которая одновременно (если она была правильно создана программистом) предоставляет документацию и позволяет отлавливать много ошибок во время компиляции». отstackoverflow.com/questions/1690197/...  Хотелось бы узнать больше об этом ... Homer6

Ваш Ответ

5   ответов
1

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

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

Спасибо вам большое! Я думаю, что это, безусловно, лучший генератор документации для JavaScript! arkod
28
Google Closure + JSDoc

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

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

ExtJS + Ext-Doc

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

YUI Док

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

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

@Betamos: Кроме того, скорее всего, можно создавать документацию так же, как они это делают. Однако, вероятно, потребуется много взлома, поскольку их инструмент генерирует документ для своей библиотеки. Может быть, вы пытаетесь заставить его генерировать еще один документ, но я не могу сделать какие-либо предположения о сложности сделать это. haylem
@Betamos: извините, никогда не замечал ваш дополнительный вопрос. Причина, по которой формат документации Closure не совсем идентичен JSDoc, заключается в том, что, насколько я знаю, они добавляют свой собственный набор параметров. haylem
Ext-Doc переименован в JSDuckgithub.com/senchalabs/jsduck Mikko Ohtamaa
Документальная аннотация инструментария JSDoc отличается от Google Closure, почему? Еще более важно, возможно ли создавать документацию, используя какую-то часть Google Closure? Их онлайн-ссылка на API выглядит потрясающе. Betamos
2

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

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

2

Проверять, выписыватьсяYUI Док.

Спасибо, проверь это ... выглядит неплохо. Homer6
2

https://github.com/senchalabs/jsduck является удивительным.

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

Я недавно использовал JSduck для extjs ... Я очень впечатлен! +1 за отличное предложение. Homer6

Похожие вопросы