私のライブラリはコードコントラクトを使用しています。
サンドキャッスルによって生成されたドキュメントにこれらの契約を組み込む方法はありますか?
私のライブラリはコードコントラクトを使用しています。
サンドキャッスルによって生成されたドキュメントにこれらの契約を組み込む方法はありますか?
編集:このメソッドは古くなっていることがわかりました。SandcastleStylesをインストールするだけです。
Sandcastleはネイティブではサポートしていませんが、CodeContractsには必要なファイルが付属しています。
まず、アセンブリのドキュメントを生成していることを確認してから、プロジェクトの[コードコントラクト]設定で、[コントラクトリファレンスアセンブリ]を[ビルド]に設定し、[コントラクトをXMLドキュメントファイルに送信する]チェックボックスをオンにします。
次に、開きますC:\Program Files (x86)\Microsoft\Contracts\Sandcastle\Sandcastle.zip
(またはC:\Program Files\...
、32ビットインストールの場合のみ-以下の手順についても同じです)。
何を抽出する必要があるかは、MSIを使用してSandcastleをインストールしたか、ソースからインストールしたかによって異なります(実際には異なるバージョンです)。
msi\vs2005\
にあるすべてのものを抽出しC:\Program Files (x86)\Sandcastle\Presentation\vs2005\
、競合を上書きします。source\vs2005\
ソースからの場合は、の下にあるすべてのものを抽出しC:\Program Files (x86)\Sandcastle\Presentation\vs2005\
、競合を上書きします。最後に、新しいSandcastleプロジェクトを作成する必要があります。ウィザードで古いトピックと設定からトピックと設定をインポートできます。
そうすれば、Sandcastleを実行して、ドキュメントに契約を結ぶことができるはずです。
それらを完全に統合するために必要ないくつかの微調整がありますが、それはサンドキャッスルで動作します。http://research.microsoft.com/en-us/projects/contracts/userdoc.pdfで入手可能な2011年2月4日(またはそれ以降)のコード契約ユーザーマニュアルのセクション8.3を参照してください。
答えは今では時代遅れです。
Sandcastlestylesは非推奨になっているようです。最新のCodeContractsディストリビューション(2013年9月13日現在)で提供されているパッチを最新のSandcastleディストリビューションに適用しようとすると、おそらくパッチが同期しなくなったためにSandcastleが破損します。サンドキャッスルのリリース。