dojo - dojojsライブラリ+jsdoc->コードを文書化する方法は？

Question

dojoを開発している人たちはどのようにしてドキュメントを作成するのですか？

ナイトリービルドから、すべてのコメントを含む非圧縮のjsファイルを取得できます。また、そこからhtmlまたはxmlを生成する何らかのドキュメントスクリプトがあると確信しています。

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

ご協力ありがとうございます

Answer 1

それはすべて、カスタムPHPパーサーとDrupalを使用して行われます。調べてみるutil/docscripts/READMEとutil/jsdoc/INSTALL、ドキュメントの生成方法に関する厄介な詳細をすべて入手できます。

jsdoc-toolkitやJSDocとは異なります（あなたが発見したように）。

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

また、明確にするために、私は道場自体を開発していません。仕事でよく使うだけです。

Answer 2

「dojojsdoc」プロセスには2つの部分があります。PHPで記述されたパーサーがあり、リストされた名前空間全体のxmlやjsonを生成します（util / docscripts / modulesで定義されているため、独自の名前空間を追加できます。ファイル「generate」の上に基本的な使用方法があります。 php "）と、drupalモジュール/プラグイン/その他としてインストールされる"jsdoc"と呼ばれるDrupalパーツ。

Drupalの側面は、このデータに対するDojoの基本的な見方にすぎません。巧妙に作成されたXSLTまたはjsonを反復処理してhtmlを生成するものはまったく同じように機能しますが、どちらもデフォルトでは提供されていません（貢献が大好きです！）。Drupalは、しばらくの間api.dojotoolkit.orgで実行されていますが、私は自分自身でDrupalビットを敬遠しています。

ドキュメントパーサーは公開されているため、その検査機能を使用して独自のカスタム出力を作成することもできます。これを使用して、[かなりずさんな]PHPファイルutil/ docscripts /makeCix.phpでKomodo.cixコード補完を生成します。このファイルは、見つかった情報を、そこでの仕様に一致するように作成されたXMLドキュメントにダンプします。これを変更して、少し手間をかけて選択した任意の種類の出力を生成できます。

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