36

（jquery、アンダースコア、バックボーンで構築された）javascriptプロジェクト用のドキュメントジェネレーター（javaのjdocまたはrubyのrdocに類似）を選択する必要があります

候補者：

要件

  • jquery、アンダースコア、バックボーンで動作するはずです。つまり、オブジェクトリテラルメソッドなどです。
  • 私はpdocが本当に好きですが、プロトタイプが中心であり、文書化が不十分であり、それを機能させるために余分なファイル（セクション？）を作成したくありません（これについてはわかりません）
  • doccoは素晴らしいですが、構造化された出力が必要です（jdocのようなメニュー+クラス/関数構造のように）
  • コマンドライン/makefile互換である必要があります（Webパスティではありません）

ヒント、トリック、チュートリアル、サクセスストーリー、アドバイスは大歓迎です。

jQueryがJSDocを使用しないのはなぜですか？

4

5 に答える 5

5

Sencha の jsduck を一番上に評価します。私は多くのプロジェクトでそれを使用しました。使い方は簡単

https://github.com/senchalabs/jsduck

1 つのコマンドで、 http://docs.sencha.com/touch/2-0/のようなドキュメントが生成されます。

于 2012-08-09T14:19:07.187 に答える
1

私は現在、同じ演習を行っていますが、私が見た限りでは、YUI Doc が最高です。「サーバー」モードで実行して、ドキュメントを作成しながら表示できるという事実が気に入っています。ドキュメントを変更するたびにビルドを実行するよりもはるかに優れています。また、生成されるドキュメントは非常に読みやすく、よく整理されています。

于 2012-08-27T16:10:54.350 に答える
1

TJ HolowaychukのDoxを見ることもできます。これは Docco のフォークですが、いくつかの jsDoc 構文サポートが追加されています。個人的には、jQuery コードは Docco のような緩いスタイルのインライン ドキュメントに適していることが多いと思いますが、現在、どのドキュメント システムを使用するかを決定しようとしているのと同じ状況にあります。

于 2011-06-30T21:54:34.590 に答える
1

これは新しいため、出力要件に合わない場合がありますが、njsdocは興味深いものになるかもしれません。ほとんどの JS ドキュメンターとは異なり、注釈のためにファイルを解析するだけでなく、コードを実行してスタックを調査することによってドキュメントを作成しようとします。

https://bitbucket.org/nexj/njsdoc

于 2012-11-29T20:27:09.310 に答える
-1

DocumentJSがあります*

*私はそれを使用したことがなく、Backbone とどの程度うまく統合できるかわかりません。

于 2011-06-27T15:20:19.993 に答える