8

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

ユーザーマニュアルを含む単一のソースファイル（HTML？）のセットが欲しいのですが、それらから以下を生成します。

  • PDFドキュメント
  • CHMヘルプ
  • ヘルプのHTMLバージョン

内容は基本的に3つのフォーマットすべてで同じです。

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

4

6 に答える 6

7

はい！

  • SandCastleを使用して、APIのCHM/HTMドキュメントを作成します。
  • DocBook + FOPおよびその他のツールを使用して、PDF、RTF、HTMLなどの他の種類のドキュメントを作成します。

NAntを介してCruiseControl.NETと簡単に統合できます。

于 2008-09-22T10:11:43.173 に答える
6

doxygenを試しましたか？Windowsでも利用可能であり、ビルドスクリプト/プロセスに簡単に統合できるはずです。

于 2008-09-22T10:16:00.713 に答える
2

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

一般に、ドキュメントをXMLで作成する方がよいでしょう。そこから、必要なものをほぼすべて生成できるはずです。

于 2008-09-22T10:12:51.610 に答える
1

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

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

于 2008-09-22T10:49:24.457 に答える
1

API も文書化する必要があり、msbuild を使用している場合は、DocProject を使用して SandCastle ビルドを制御することを検討してください。(これらのツールは、エンド ユーザー向けのドキュメントではありません...)

于 2008-10-10T14:44:03.487 に答える
0

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

于 2008-10-10T14:47:17.820 に答える