0

C++ から C# および WinRT に移行する開発者グループがいます。私たちは C++ 開発者向けビルドの一部として D'Oxygen を使用しましたが、C#/WinRT での開発者向けビルドの一部として引き続きドキュメントを生成したいと考えています。

XML Doc 生成をオンにするのは簡単で、不正なタグの警告が表示されると思いますが、実際の HTML 出力がなければ、開発者は貴重なフィードバックを逃すことになると思います.

NDoc は現在は機能していないようです。Sandcastle をざっと見てみましたが、かなり複雑であることがわかりました。理想的には、開発者に過度の負担をかけたり、編集、ビルド、テスト、コミットする際に追加の手順を覚えておく必要がないものを探しています。言い換えれば、最善の解決策は、ビルド後のステップのように「ちょうど起こる」ものであり、各開発者のビルド時間が大幅に増加することはありません。

C#/WinRT でこれを行った経験のある人がいる場合は、アドバイスをお願いします。

前もって感謝します！

4

2 に答える 2

1
  1. Sandcastle Help File Builderを入手してください。
  2. Visual Studio ソリューションでライブラリのヘルプ プロジェクトを作成します。
  3. デバッグは開発中に最も頻繁に使用されるため、リリース構成でのみドキュメント プロジェクトをビルドするには、デバッグ ソリューション構成からビルド チェック マークを削除します。リリース ビルド テストまたはパフォーマンス テストでは、別のソリューション構成を作成するか、単にオプションを前後に切り替えることができます。
  4. ドキュメントを一度ビルドする
  5. ドキュメント ファイルをソリューションに含めて、ファイルが変更されたときに [保留中の変更] ウィンドウに表示されるようにします。
  6. チェックイン前にドキュメントを更新するリリース構成でビルドするか、他のポリシーを使用してドキュメントの更新を要求するよう開発者に依頼してください。

構成マネージャーの開始 デバッグ構成に対してドキュメントのビルドが無効になっている構成マネージャー .chm ファイルの更新を簡単に確認できるソリューション構造

ドキュメントを常にビルドするのは意味がないと思いますが、更新されたバージョンが実際に必要になったときに簡単にビルドできるようにしておくと、非常に迅速にビルドできるようになります。

また、FXCop または StyleCop (どちらか忘れた) を使用し、XML ドキュメントの欠落に関する警告をエラーとして処理するように構成することもできます (少なくともリリース ビルドでは)。デバッグ構成のためにこれを行うと、開発が遅くなり、変更が困難になる可能性があります。開発者は、文書化する価値のある最終的な実装にコミットする前に、いろいろなことを試したいと思うことがよくあるからです。

編集*

Sandcastle は、プロジェクト プロパティに示されているように、さまざまな出力形式を提供します。

ここに画像の説明を入力

于 2013-02-07T05:37:09.677 に答える
1

ForgeDoc (私が開発者です)について言及したいと思います。それはあなたが探しているものかもしれません。高速かつシンプルになるように設計されており、適切な MSDN のような HTML 出力を生成します。また、コマンド ライン インターフェイスも備えているため、Visual Studio のビルド後のイベント コマンドから呼び出すことができます。

皆さんの考えをお聞きしたいので、ぜひ試してみてください。

于 2013-02-10T06:31:16.667 に答える