25

私は自分のアプリケーションに関する広範な JavaDoc ドキュメントを作成し、多くの有用な情報をoverview.htmlおよびpackage.htmlファイルに追加しました (前者の図へのリンクを含むdoc-files/)。Maven の Javadoc プラグインは、標準の javadoc ツールを適切に使用して従来の JavaDoc フレームセットを生成しますが、ここではドキュメント全体を含む PDF を生成する必要があります。

AurigaDocletは非常にきれいな PDF を生成し、DocFlexも機能させることができました。ただし、どちらも myoverview.htmlpackage.htmlfiles を無視します (Maven の内部と外部の両方で試してみました。長い目で見れば HTML が必要なので、PDF は 1 回限りのものになります)。

AurigaDoclet に Java 以外のファイルを認識させる方法を知っている人はいますか? または、別の方法として、ソース コードまたは JavaDoc で生成された HTML から見栄えの良い PDF を生成しますか?

4

4 に答える 4

23

ばっちり成功。ソースから直接生成するために可能なすべてのツールを試した後、HTMLDOCに戻りました。JavaDoc 対応ではありませんが、非常によくできているため、少し調整するだけでかなり使いやすい PDF を生成できます。

ここに私がそれをした方法の段階的な説明があります:

  1. リリース ページでソフトウェアをダウンロードします。

  2. 好みの方法で従来の HTML ドキュメントを生成します (Ant、Maven、コマンドライン javadoc - 任意)。

  3. GUI は便利ですが、すべてのファイルを手動で追加するのは面倒なので、ドキュメント タイプを「Web ページ」に設定して .book ファイルを作成し、生成された javadoc のルート フォルダから HTML ファイルの 1 つを追加します (例: overview-summary. html、誰でもできますが、これはステップ 5 の参照用です)。[出力] タブで、PDF 形式を選択して名前を設定し、その他のオプション (ロゴ、色、その他のクールなもの) を自由に追加できます。このプロジェクトを保存し (たとえば、myjavadocpdf.book)、GUI を閉じます。

  4. javadoc 内のすべての HTML ファイルのリストを生成します。私はCygwinの find コマンドでそれを行いました (私の DOS/cmd シェルの時代はとうの昔に終わりました) が、ファイル リストを取得する限り、何でも好きなように実行できます。私の場合、find . | grep html$ | sort -r > files.txtうまくいきました。Windows ユーザーの場合も、同じことを行う必要があります (ただし、次のステップで s が s のように表示される場合は、s をsdir /s/b *.html > files.txtに置き換える必要があることに注意してください)。\/

  5. ステップ 3 で生成された .book ファイルをお気に入りの純粋なテキスト エディターで開き (プログラマーとして、それについて強い意見を持っている必要があるので、私の意見は自分の意見だけにしておきます - ではありません;-))、ステップ 4 で生成されたリストをこれに追加します。 .book ファイル (最後にファイルのリストが保持されるため、作業が非常に簡単になります)。グローバル検索/置換で必要な場合は、相対パスを修正することを忘れないでください (そのため、ステップ 3 で少なくとも 1 つのファイルを追加する必要がありました - htmldoc が期待するファイル パス パターンを確認するため)。

  6. ここで、ファイルを便利な順序で並べ替える必要があります。最初に概要を記載し、次にパッケージの説明と各クラス、次に完全な索引、その他すべてを最後に記載します。削除したファイルはすべて外部リンク (したがって破損) になることに注意してください。慎重に選択してください。

  7. .book ファイルを保存し、HTMLDOC で再度開きます。出来上がり: すべてのファイルが追加され、並べ替えられました。生成をクリックします。それでおしまい!

画像をいじる必要があるかもしれません (ヒント: スタイル/CSS ではなく、HTML の幅/高さを使用してください)。最終的に、結果として得られるファイルは驚くほど優れています。見栄えがよく、内部リンクと外部リンクを完全にナビゲートできます。ツールが Java(Doc) にまったく対応していないことを考えると、印象的です...

編集: ソフトウェアは現在、元の作成者から無料です。更新されたリンク、ありがとう@mohammed

于 2010-02-24T07:24:45.447 に答える
2

Sun JavaDoc FAQ によると、いくつかのオプションがあります。ほとんどが無料で、1 つまたは 2 つの商用サービスもあります。http://java.sun.com/j2se/javadoc/faq/index.html#printで確認してください。

于 2010-02-23T22:32:34.370 に答える
2

AurigaDoclet は package.html の処理に失敗します。修正については、https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1で私のコメントを参照してください。

于 2011-08-30T11:49:44.940 に答える
2

とにかくこの質問がぶつけられた場合、これを使用してltxdocletプロジェクトをリンクできます。

これはソースから (JavaDoc プラグインであることにより) ドキュメントを LaTeX 形式で作成し、これを PdfLaTeX を介して渡して PDF を生成できます。

オプションで、きれいに印刷されたソース コードを含めることもできます。

于 2011-08-30T15:26:40.073 に答える