自動ビルドでドキュメントを生成する

StackOverflow https://stackoverflow.com/questions/114095

質問

自動ビルド中にプロジェクト ドキュメントを生成する方法はありますか?

ユーザーマニュアルを含むソースファイル (HTML?) を 1 セット用意し、そこから次のものを生成したいと考えています。

  • PDFドキュメント
  • CHMヘルプ
  • HTML版のヘルプ

内容は 3 つの形式すべてで基本的に同じです。

現在、msbuild と CCNET を使用していますが、必要に応じて変更できます。

役に立ちましたか？

解決

はい！

  • 使用 砂のお城 API の CHM/HTM ドキュメントを構築します。
  • 使用 ドックブック + FOP PDF、RTF、HTML などで他の種類のドキュメントを作成するためのその他のツール...

これらは、CruiseControl.NET と簡単に統合できます。 NAnt.

他のヒント

試しましたか 酸素?Windows でも利用でき、あらゆるビルド スクリプト/プロセスに簡単に統合できます。

Apache Forrest プロジェクトは、あなたが望むものを提供する何らかの形で役立つかもしれません。

一般的には、ドキュメントを XML で記述する方が適切です。そこから、必要なものはすべて生成できるはずです。

ヘルプとマニュアルは、単一のソースから高品質の PDF、HTML、CHM (およびその他の形式) を生成できます。コマンドラインインターフェースも備えています。私はバージョン 4 を持っていますが、とても気に入っています。私は条件文 (#ifdefs など) を使用して、Windows および Mac バージョンのドキュメントをビルド .bat/.csh ファイルの一部としてさまざまな形式で生成します。バージョン 5 が利用可能になりました。

http://www.ec-software.com/

API も文書化したい場合で、msbuild を使用している場合は、使用を検討してください。 ドキュメントプロジェクト を制御する 砂のお城 建てる。(これらのツールはエンドユーザーのドキュメント用ではありません...)

私は Doxygen を使用した経験があります。これは便利で簡単ですが、後のドキュメント作成作業を容易にするためにコードをオーバーコメントしたくなるでしょう。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top