2009-08-19 12 views
6

私はdojoを開発している人たちがドキュメンテーションをどのように作成するのか聞いてみたいと思います。dojo js library + jsdoc - >コードを文書化する方法?

夜間のビルドからは、すべてのコメントを含む非圧縮のjsファイルを取得することができます。いくつかの種類のhtmlまたはxmlファイルを生成するスクリプトがあります。

jsdocはutilsフォルダにありますが、使用方法はわかりません。 jsDocツールキットは元のdojoファイルとは異なる表記/**commenting**/を使用します。すべてのあなたの助けを

おかげ

答えて

4

これは、すべてのカスタムPHPパーサとDrupalので行われます。 util/docscripts/READMEutil/jsdoc/INSTALLを見ると、ドキュメントをどのように生成するかに関するすべての細部の詳細が得られます。

jsdoc-toolkitまたはJSDoc(youv'eが発見したとおり)とは異なります。

FWIW、私はjsdoc-toolkitを使用しています。静的なHTMLを生成するのがはるかに簡単で、Googleコードページのタグに関する多くのドキュメントがあります。

また、明確にするために、私は道場そのものを開発しません。私は仕事でそれをたくさん使っています。

+0

真。私はjsdocの方法で行った。短い説明のためにありがとう! – belzebu

4

「dojo jsdoc」プロセスには2つの部分があります。 PHPで書かれたパーサーは、リストされた名前空間全体(xmlや/またはjsonを生成する)(util/docscripts/modulesで定義されているので、独自の名前空間を追加することができます。 Drupalモジュール/プラグイン/その他のものとしてインストールする "jsdoc"と呼ばれるDrupalの部分です。

このデータのDrupalの側面は、Dojoの基本的なビューです。よく作られたXSLTやjsonを反復してhtmlを生成するものはまったく同じですが、どちらもデフォルトで提供されていません(貢献が大好きです)。私はDrupalビットから自分自身を恥ずかしがりますが、今はapi.dojotoolkit.org上で動作しています。

docパーサーが公開されているため、検査機能を使用して独自のカスタム出力を作成することもできます。私はKomodo .cixのコード補完を生成するために、PHPのutil/docscripts/makeCix.phpファイルを作成します。これは、そこにある仕様に合うように作られたXML文書に情報をダンプします。これを少し変更して、どんな種類の出力を生成するように変更することもできます。

ドキュメント構文はすべてのスタイルガイドラインのページで定義されています。 http://dojotoolkit.org/reference-guide/developer/styleguide.html

関連する問題