3

最近、コード ドキュメント ソリューションとして Apache Forrest を検討しています。アパッチのウェブサイトから、

「Apache Forrest™ ソフトウェアは、さまざまなソースからの入力を 1 つ以上の出力形式で統一されたプレゼンテーションに変換するパブリッシング フレームワークです。Apache Forrest のモジュール式で拡張可能なプラグイン アーキテクチャは、Apache Cocoon と、プレゼンテーションを分離する関連する業界標準に基づいています。 Forrest は静的ドキュメントを生成したり、動的サーバーとして使用したり、自動化された機能によって展開したりできます。」

私は、Apache Forrest を、JavaDoc コメントを備えた Java コードのドキュメントを整理して投稿する方法として使用できるかどうか疑問に思っていました。JavaDoc がそれ自体でできることは知っていますが、Apache Forrest が追加のカスタマイズを提供しているように感じます。Apache の Web サイトで Maven に組み込む方法の説明を見つけましたが、Maven 1.x 向けに調整されているようで、Maven 2 を使用しています。このようなことは可能ですか? もしそうなら、それを統合するための最良の方法は何ですか?

ありがとうございます。

4

1 に答える 1

6

Documenting Projects with Apache Forrestで、著者はForrest Alternativesについて次のように書いています。

Maven に精通している場合は、なぜ Forrest をわざわざ使うのか不思議に思うかもしれません。Maven は、Forrest が行うすべてのことを行います。さらに、ビルドを完全に自動化し、JUnit および CVS レポートを添付し、基本的なドキュメントに加えてあらゆる種類の有用な情報を追加します。新しく生成された Web サイトをリモート ホストに自動インストールするためのターゲットも提供します。

私は多くのプロジェクトで Maven を使用してきましたが、これは印象的なパッケージです。学習曲線は、基本的な使用については Forrest のものよりもそれほど悪くはありません。また、Maven を使用する場合は Ant を学習する必要がないため、ゼロからプロジェクトをセットアップする場合は間違いなくさらに少なくなります。ただし、Forrest は全体としてそれほど複雑ではありません。Maven が提供するものすべてが必要ない場合は、Forrest から始めて、後で必要に応じて Maven に移行することをお勧めします。Forrest は、Ant に基づく既存の大規模なビルド システムがある場合にも適しています。すべてのビルド スクリプトを書き直してプロジェクトを Maven 化する代わりに、Maven スタイルの Web サイト生成を段階的に追加できます。

純粋なドキュメントの代替案に関しては、多くのオープン ソース コミュニティ サポートを備えたもう 1 つの確実なオプションは DocBook です。DocBook を使用して 747 のマニュアルを作成することもできます。これは、テクニカル ライティング用の究極の SGML (または XML。2 つのバージョンがあります) の方言です。XML バリアントには、DocBook ソースから HTML、PDF、RTF (Microsoft Word) およびその他の形式を生成できる、Norman Walsh による優れたスタイルシートのセットがあります。Forrest の XML ダイアレクトはケースの 80% をカバーし、学習曲線ははるかに短いと思いますが、印刷ドキュメントも作成する必要がある大規模なプロジェクトでは、DocBook を検討する価値があります。DocBook から移行する場合、Forrest は DocBook/XML のサブセットのレンダリングもサポートしていますが、十分にサポートされていないことに注意してください。

すでに Maven を使用しているのに、なぜ Forrest を検討するのか、本当に疑問に思います。Maven の可能性についてまだ疑問がある場合は、Maven Doxiaをチェックしてください。

また、DocBook を使用したい場合で、Doxia による Maven のネイティブ サポートがあまりにも限られている場合は、Docbkx Maven プラグイン( Maven Docbook プラグインよりも推奨) があります。

于 2009-09-21T23:02:51.643 に答える