30

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 が使用している特定のジェネレーターを自分のソースに使用できるかどうかを知りたいです (問題があれば、オープン ソースになります)。

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

4

5 に答える 5

28

Google クロージャ + JSDoc

コメントで述べたように、これらはJSDoc Toolkitを基に構築され、Closure Compiler が型チェックなどに使用する特別な注釈を追加しますが、これは、クロージャー コードの上に JSDoc を使用してドキュメントを生成することもできることを意味します。必要なルック アンド フィールで出力を生成するには、独自のテンプレートとスタイルシートを作成するだけです。

Google Closure Tools は、現時点で公開されていない部分を除き、すべてオープン ソースです。いずれにせよ、ドキュメントとソース コードを見て、それらが Javadoc を生成するために何を使用しているかを確認できます。

ExtJS + Ext-Doc

インスピレーションを得るために見て、彼らがどのようにそれを行うかを確認できるもう1つのものは、ExtJS のオンラインドキュメントです。最初はナビゲートするのに少し戸惑いますが、すぐに慣れます。オープン ソース プロジェクトExt-Docは、現在は少し古くなっていますが、同様のスタイルのドキュメントを生成します。

ユイ・ドク

Matthew Manela が述べたように、YUI Doc は非常に優れたオンライン ドキュメントも作成します。

JSDoc は多くのツールの事実上の標準であり、Java の慣行を反映しているため、JSDoc を使用することをお勧めしますが、実際には必要に応じて選択してください。

于 2010-10-19T12:27:01.050 に答える
2

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

Documentation.js の例

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

于 2016-02-08T16:31:19.240 に答える
2

ExtJs を使用している人にとって、https://github.com/senchalabs/jsduckは素晴らしいです。

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

于 2012-03-15T05:50:12.500 に答える
2

YUI Docを参照してください。

于 2010-09-29T05:11:32.207 に答える