問題タブ [docco]

doccoで生成された出力のように、文書化された C++ 実装ファイル (ヘッダー ファイルではない) で同様の出力を取得したいと思います。そのようなツールはありますか？

doccoを使用して、coffeescript を自動文書化しようとしています。以下の例では、コメントが適切に出力されます。しかし、コードは右ペインの出力に表示されません...出力として「undefined」だけです。さて、再確認したところ、前提条件のパッケージである Node.js、Pygments、CoffeeScript は既にインストールされています。

例: もの.コーヒー

私が考えることができる唯一のことは、ピグメントが正しいものを出力していないということです。これは、doccoから得たフィードバックです。

足りないものはありますか？

ありがとう

CoffeeScriptとDoccoを使用して、生成されたHTMLでセクションが作成され、リンクとして使用できます。

これらのセクションに名前を付ける方法があるかどうか誰かが知っているので、代わりに（たとえば）：

編集：これは、HTMLを手動で追加するだけで実現できるようです。

しかし、他に、おそらくもっとエレガントな方法はありますか？

doccoで coffeescript ドキュメントを生成するための ant ファイルがあります。現在、すべてのドキュメント ファイルが docs フォルダーにダンプされていることを除いて、正常に動作します。すべてのファイルを 1 つのディレクトリにフラットにダンプするのではなく、docs フォルダーにスクリプト ディレクトリの構造を反映させたいと考えています。

docco に --output 引数があることは知っていますが、ファイルセット内の各ファイルの docs フォルダーに docs ディレクトリ パスを 1 つずつ調べずに生成する方法がわかりません。

Maven を使用する Java (マルチモジュール) プロジェクトでMarginaliaを実行することは可能ですか?

または、これを行うことができる Marginalia やDoccoに似た他の代替手段はありますか?

私にとって重要なことは、それをいくつかのパブリック Maven リポジトリから依存関係として追加し、たとえば Docco の Node.js などの追加のものをインストールせずにすぐに使用できることです。これは Java プロジェクトであるため妥当です。

私はgrunt-dox grunt プラグインを使用して、 JsDocドックブロックを含む JavaScript ファイルから docco ドキュメントを生成しています。

grunt タスクを実行すると、指定したタイトルだけの HTML ファイルしか取得できません。grunt-dox のインストールまたはタスクの実行にエラーはありません。

私は Mac OS X 10.8.3 を使用していますが、それが機能しない理由ではないと強く感じています。

参照用の関連ファイルを次に示します。

• Gruntfile.js
• project.json の依存関係
• dox によって生成された index.html - 余分なスペースを含むフォーマットは無視してください
• ドキュメント化しようとしている JavaScript ファイル

私は何か間違ったことをしていますか？誰かがこれを機能させましたか？ところでgrunt test、doxタスクが含まれている実行中です。

私はこれに2日間立ち往生していて、あきらめる準備ができているので、助けていただければ幸いです.

更新:実行しようとしましdox --title POC public/javascripts/build/docs/docs.js > public/docs/index.htmlたが、永遠にハングします。

うーん。

コーヒー スクリプト ファイルのドキュメントを生成したいと考えています。ドコを使いたい。

私が使用するとき：

それはエラーをスローします。フォルダーがファイルリストにあるためだと思います。私が使用するとき：

ルートフォルダーに何もないため、いくつかのファイルが見つかりません。

すべての *.coffee ファイルをコンソールのコマンドに再帰的に与える方法は?

大規模なバックボーン スタイルのアプリケーション (最大 100 ファイル) があり、ドキュメントを自動化するための最適な方法を選択しようとしています。

docco ( grunt-docco2 を使用)を試していますが、問題が発生しています。私が持っているすべてのファイルを左側にリストしてから、スクロールする方法がないままウィンドウを通り過ぎます。おそらくドロップダウンのスタイルで、それらをグループ化することは可能ですか?

また、インデックスページなどを生成してもらうことは可能でしょうか? Docco は私が望むすべてのことの 99% を行うようですが、この 2 つのことが私を夢中にさせています!

coffeescript ドキュメントを作成するためのツールとして docco を使用しています。

デフォルトでは、coffeescript ソースで作成したすべてのコメントはドキュメントとして扱われ、左側 (説明) の列に移動されます。問題は、私のソースにはコメントアウトされたコード行がいくつかあり、代替オプションとして残されているため、右側の (コード) 列に残しておきたいことです。

docco-「それには触れないでください。これは通常のコードのように残してください」と伝える方法はありますか? 「#!」または「#ignore」でしょうか？前もって感謝します。