1

私はかなりのサイズの(そして成長している)フレームワークの作者です。これは主にJavaScriptAPIを公開しますが、RubyのパブリックAPIと成長しているCoffeeScriptセグメントもあります。(CoffeeScriptは最終的にプロジェクトの大部分を網羅しますが、常に重要な純粋なJavaScriptの存在が存在します。)

これまで、JavaScriptをPDocで、RubyをRDocで文書化してきました。私はRDocに問題はありませんが、残念ながらPDocは古く、メンテナンスが多く、余分な雑然とした感じのタイピングを大量に必要とします。また、ほとんどのコードをCoffeeScriptに移行すると、PDocの有用性が大幅に低下します。

プロジェクトの現在のドキュメントの例

私は地元の支店でRoccoを試しましたが、予想よりもうまく機能しました。本当に素晴らしいのは、RubyからCoffee、JSまで、私のすべてのコードで機能することです。すべてのドキュメントを1か所で確認できるのは素晴らしいことです。ドキュメントの横にソースコードが表示されるのもいいですね。これにより、特定のコードセグメントが実際に何をしているのかが非常に明確になります

ただ、全体の構造が少し気になります。Docco / Roccoは、パブリックAPIがほとんどないニッチなプロジェクトには最適のようですが、プロジェクト全体を読み取るスタイルは、両刃の剣として私を驚かせます。非常に有益ですが、目次がなくてもファイルを垂直方向にスクロールしなければならない(言うまでもなく、最初にどのファイルに移動するかを知っている)と、実際に何かを見つけるのが難しくなるようです。また、ファイルのリストが長すぎて表示できないため、デフォルトのテンプレートではハッキングが必要でした。大したことではありませんが、煩わしさ、そしてこのプロジェクトがロッコのリーグから外れているかもしれないというヒント。

私は今CoffeeDocを検討しています。例から判断すると、それは有望に思えますが、もちろんコーヒー中心であり、RDoc、CoffeeDoc、そして-何の3つの別々のドキュメントツールを実行することに戻りますか?JSDoc?

私は別々のソースに対して別々のツールを実行することに完全に反対しているわけではありませんが、それを3つの別々のWebサイトのように感じられない一貫した結果に調整するのは難しくなります。

ですから、私の質問は、どのツールを使用または提案しているのかということだと思います。どの言語をサポートしていますか?あなたのプロジェクトである干し草の山の中から針を閲覧し、読んで、実際に見つけるのは簡単ですか?このような問題に誰も遭遇していないとは信じられないことを除いて、私はこの時点で自分のツールをロールすることを検討しています(そして、必要がなければ本当に時間を無駄にしたくありません)。

4

1 に答える 1

1

Sphinxはjavascriptを直接サポートしています。RubyとCoffeeScriptのドキュメントは、拡張機能(https://bitbucket.org/birkenfeld/sphinx-contrib/)を通じてサポートされています。

ウェブサイトから:

次の機能が存在し、正常に動作し、Pythonドキュメントで「動作中」に表示されます。

  • 出力形式:HTML(Windows HTMLヘルプを含む)、LaTeX(印刷可能なPDFバージョン用)、マニュアルページ、プレーンテキスト
  • 広範な相互参照:関数、クラス、引用、用語集用語、および同様の情報のセマンティックマークアップと自動リンク
  • 階層構造:兄弟、親、子への自動リンクを備えた、ドキュメントツリーの簡単な定義
  • 自動インデックス:一般インデックスとモジュールインデックス
  • コード処理:Pygments蛍光ペンを使用した自動強調表示
  • 拡張機能:コードスニペットの自動テスト、Pythonモジュール(APIドキュメント)からのドキュメント文字列の組み込みなど
于 2012-05-14T22:08:12.120 に答える