web-dev-qa-db-ja.com

Google Closure LibraryAPIドキュメントのようなJavascriptAPIドキュメントを生成する方法はありますか?

JavascriptソースコードのHTMLドキュメントを生成するツールを見つけようとしています。

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が使用している特定のジェネレーターを自分のソース(重要な場合はオープンソースになる予定)で使用できるかどうかを知りたいのですが。

前もって感謝します...

30
Homer6

Google Closure + JSDoc

コメントであなた自身が述べたように、それらは JSDoc Toolkit に基づいて、型チェックなどのためにクロージャーコンパイラーによって使用される特別なアノテーションを追加しますが、これはクロージャーの上にJSDocを使用することもできることを意味しますドキュメントを生成するためのコード。目的のルックアンドフィールで出力を生成するには、独自のテンプレートとスタイルシートを作成するだけです。

Google Closure Toolsは、現時点で開示されていない一部のビットを除いて、すべてオープンソースです。いずれの場合も、ドキュメントとソースコードを見て、Javadocの生成に何を使用しているかを確認できます。

ExtJS + Ext-Doc

インスピレーションを得て、それがどのように行われるかを確認できるもう1つの方法は、 ExtJSのオンラインドキュメント です。最初はナビゲートするのが少しわかりにくいと思いますが、すぐに慣れます。オープンソースプロジェクト Ext-Doc は、少し時代遅れになっていますが、同様のスタイルのドキュメントを生成します。

YUI Doc

Matthew Manelaが述べたように 、YUIDocはかなり優れたオンラインドキュメントも作成します。

JSDocは多くのツールのデファクトスタンダードであり、Javaプラクティスを反映しているので、私のアドバイスはJSDocを採用することですが、それは本当にあなたが望むもの次第です。

28
haylem

新しいオプションは http://documentation.js.org/ で、JSDocを使用してHTMLを生成します。

Documentation.js example

Gulpで実行できます https://github.com/documentationjs/gulp-documentation

2
Andrew

チェックアウト YUI Doc

2
Matthew Manela

ExtJsを使用している場合は、 https://github.com/senchalabs/jsduck が最適です。

ExtJSを使用していないが、Rubyに精通している場合は、 https://github.com/b-studios/doc.js が最適です。

2
Utensil

Dossier は現在(2016)を構築するために使用されています クロージャーライブラリのドキュメント 。これはClosureCompiler自体の上に構築された素晴らしいツールであるため、実際にはコンパイラーを使用してすべての型情報を読み取り、コードの代わりにドキュメントを出力します。

ドキュメントのユーザーインターフェイスについては、まだいくつかの作業が行われています。現在、Closure Libraryのドキュメントページはかなり空っぽに見えます。開始するには、左上の「ハンバーガーメニュー」記号をクリックする必要があります。

1
owler