0

短縮版

見栄えの良いPDFを生成できるMavenDoxiaの代替手段が必要です（少なくともコードスニペットは適切にインデントされ、フォントサイズを構成できる必要があります）。Mavenの連中はDOXIA-419でmaven-pdf-pluginを提案しましたが、同じ問題があります。前述のDOXIA-419には、Doxiaで経験した問題の詳細が記載されています。

詳細版

Java / C / C ++ / C＃/etcAPIを提供するBIG製品を開発しています。クライアントがカスタマイズした数十のブランチが同時に保守/開発されます。これらの要件を満たす自動ドキュメント生成を容易にするツールが必要です。

  1. Java / XML/etcサンプルからの任意のスニペットを含めます。Confluenceスニペットプラグインはこの機能の良い例です。

  2. 見栄えの良い印刷可能なドキュメント（PDFなど）を生成します。

  3. クリック可能な相互参照など（HTMLなど）を持つオンラインドキュメントを生成します。

  4. 無人モード（たとえば、Antスクリプトからドキュメント生成プロセスを簡単に実行できる必要があります）。

  5. ドキュメントのソースコンテンツ（後でPDFなどが生成される）は、人間が読める形式で保存する必要があります。

  6. ドキュメントのソースコンテンツは、（Javaソースではなく）別のファイルに保存する必要があります。

  7. （Java / xml / etc）構文の強調表示をサポートします。

更新：8。WindowsOSの互換性。

4

1 に答える 1

3

私のオープン ソース プロジェクト Dexy があなたに役立つかもしれません。これはドキュメントの自動生成ツールではなくオーサリング ツールであるため、構造全体を自動的に作成する JavaDoc とは異なります。ソース コードとドキュメント コンテンツは別々に保持され、構文の強調表示のサポートは非​​常に優れており、ドキュメントのスニペットが利用可能です。私は見栄えの良い印刷可能なドキュメントに LaTeX を使用していますが、必要に応じて、PDF にコンパイルされる他のテキストベースの形式を使用することもできます。クリック可能な相互参照については、HTML テンプレートを記述して自動的に入力する必要があります (私は現在、プロジェクトの JavaDoc を置き換えています)。ライブ コード例を実行して、この出力をドキュメントに含めることもできます。

http://dexy.it

于 2011-03-08T07:26:29.580 に答える