21

Visual Studio のビルド ステップで HTML ドキュメントを自動的にビルドするには、どのような手順を実行する必要がありますか? すべてのコメントが配置され、comments.xml ファイルが生成され、Sandcastle がインストールされました。ドキュメントを生成するために、ビルド後のステップに何を追加すればよいかを知る必要があります。

4

5 に答える 5

33

この質問が出されてから、いくつかの変更が加えられました。Sandcastle には が含まれなくなりましSandcastleBuilderConsole.exeた。代わりに、plain old を使用しますMSBuild.exe。

これをビジュアルスタジオと統合するために、私がしたことは次のとおりです。

これをビルド後のイベントに配置します。

IF "$(ConfigurationName)"=="Release" Goto Exit

"$(SystemRoot)\microsoft.net\framework64\v4.0.30319\msbuild.exe" /p:CleanIntermediates=True /p:Configuration=Release "$(SolutionDir)ProjectName\doc\DocumentationProjectName.shfbproj"

:Exit

これにより、「リリース」モードでビルドする場合にのみ、Visual Studio がドキュメントをビルドします。そうすれば、開発中に「デバッグ」モードでビルドするときに永遠に待つことはありません。

いくつかのメモ:

  • 私のシステムは 64 ビットです。そうでない場合は、へのパスを に置き換えframework64てください。frameworkmsbuild.exe

  • セットアップ方法は、ソリューション内の各プロジェクトを個別に文書化することです。いくつかのプロジェクトを一緒に含む "Sandcastle Help File Builder" プロジェクト ファイルがある場合は、削除してソリューション ディレクトリにProjectName\移動することをお勧めします。docこの場合、ビルド後のイベント コマンドは、ソリューションで最後にビルドされたプロジェクトにのみ配置する必要があります。すべてのプロジェクトのビルド後のイベントに配置すると、ビルドされる各プロジェクトのドキュメントが再構築されます。言うまでもなく、しばらくそこに座っています。個人的には、各プロジェクトを個別に文書化することを好みますが、それは私だけです。

Sandcastle と「Sandcastle Help File Builder」をインストールします。

Sandcastle と "Sandcastle Help File Builder" を正しくセットアップする方法がわからない場合は、次の手順に従ってください。

  1. http://sandcastle.codeplex.com/から Sandcastle をダウンロードしてインストールします (64 ビット システムを使用している場合は、環境変数を追加する必要があります。手順はこちら.

  2. http://shfb.codeplex.com/から "Sandcastle Help File Builder" をダウンロードしてインストールします (MSHelp2 に関する警告が表示されても無視してください。これは必要ありません)。

  3. それらをインストールしたら、"Sandcastle Help File Builder" を使用して新しいドキュメント プロジェクトを作成します。ファイルの保存場所を尋ねられたら、ソリューション/プロジェクトにあるドキュメント フォルダーに保存します。 http://www.chevtek.com/Temp/NewProject.jpg

  4. 新しいプロジェクトを作成したら、作成するドキュメントの種類を選択する必要があります。コンパイルされた Windows ヘルプ ファイル、Web サイト、またはその両方。 http://www.chevtek.com/Temp/DocumentationType.jpg

  5. ドキュメントを生成するディレクトリに SHFB プロジェクト ファイルを保存した場合は、この手順を省略できます。ただし、生成されたドキュメントを別の場所に配置したい場合は、出力パスを調整する必要があります。 http://www.chevtek.com/Temp/OutputPath.jpg 注: 出力パスについて覚えておくべきことの 1 つ (1 時間イライラさせられました) は、必要なドキュメントの種類として Web サイトをチェックすると、出力パスのコンテンツが上書きされることです。彼らがあなたに伝えていないことは、SHFB が特定のフォルダーが出力パスの一部として含まれないように意図的に制限したということです。デスクトップはそのようなフォルダーの 1 つです。デスクトップのサブフォルダーであっても、出力パスをデスクトップにすることはできません。マイドキュメントでもできませんが、ドキュメントのサブフォルダーにすることはできます。ドキュメントのビルド中にエラーが発生した場合は、出力パスを変更して、問題が解決するかどうかを確認してください。詳細については、 http://shfb.codeplex.com/discussions/226668?ProjectName=shfbを参照してください。

  6. 最後に、文書化するプロジェクトへの参照を追加する必要があります。私のように個別のプロジェクトを行っている場合は、作成する SHFB プロジェクト ファイルごとに、対応する .CSPROJ ファイルを参照します。ソリューション全体に対して 1 つの SHFB プロジェクトがある場合、ソリューションの .SLN ファイルが見つかります。(コンパイルされた DLL を参照する場合もサンドキャッスルは機能しますが、Visual Studio と統合しているため、代わりにプロジェクト/ソリューション ファイルを参照する方が理にかなっています。 DLL ではなくコードを参照しているため、ビルド後のイベントを実行しますが、安全を確保し、ビルドされた最後のプロジェクトに配置することをお勧めします) http://www.chevtek.com/Temp/AddSource.jpg

  7. プロジェクトを保存すると、"Sandcastle Help File Builder" を閉じることができます。これですべての設定が完了しました。ドキュメント プロジェクト ファイルは、ビルド後のイベントでバッチ コマンドが指す適切なフォルダーに配置してください。

私の短いチュートリアルがお役に立てば幸いです。サンドキャッスルを Visual Studio と統合する方法は言うまでもなく、サンドキャッスルの使用方法を示す適切なチュートリアルを見つけるのは非常に困難でした。今後の Google 検索でこの質問が表示されることを願っています。

于 2011-03-05T00:43:29.567 に答える
6

Codeplexから Sandcastle Help File Builder をインストールすることをお勧めします。

これはコマンド ラインから、たとえばビルド後のイベントから実行できます。最も単純なコマンド ラインは次のとおりです。

<install-path>\SandcastleBuilderConsole.exe ProjectName.shfb

Sandcastle は非常に遅いため、リリース ビルドでのみ実行します。これを行うには、次のようなコマンドでビルド後のイベントを作成します。これにより、構成名がバッチ ファイルに渡されます。

CALL "$(ProjectDir)PostBuild.cmd" $(ConfigurationName)

次に、バッチ ファイル内で、最初の引数が "Release" であるかどうかをテストし、そうであれば SandcastleBuilderConsole.exe を実行します。

于 2008-10-17T10:51:16.107 に答える
1

上記のようにこれを行う簡単な方法は、Sandcastle ヘルプ ファイル ビルダを使用することです。コマンド ラインからのビルド プロセスにいくつかの変更が加えられ、これらのプロジェクトを SandcastleBuilderConsole.exe の代わりに MSbuild でビルドできるようになりました。したがって、あなたがしなければならないことは次のとおりです。

MSbuild.exe プロジェクト名.shfb

于 2011-01-20T16:59:15.680 に答える
0

Sandcastle の現在のバージョンには少し欠けている点があることは認めざるを得ません。大規模なプロジェクトの場合、非常に遅く、統合するのは簡単ではありません (まだ初期段階のため)。

通常の使用では、リフレクターをdllファイルとxmlファイルのあるフォルダーに向けるだけで簡単だと思います.IIRCでは、ナビゲートするとxmlファイルがロードされます。

さらに、とにかくほとんど常にリフレクターを開いています...

[編集] チェックあり、はい - 逆アセンブラ パネルに xml コメントが表示される

于 2008-10-17T10:54:29.127 に答える
0

これらをインストールします。

NDoc: http://prdownloads.sourceforge.net/ndoc/NDoc-v1.3.1.msi?download

HTML ヘルプ ワークショップ: http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

次に、NDocConsole.exe コマンド ラインを使用して、MSDN または CHM 形式でドキュメントを生成します。

@c:\progra~1\NDoc\NDocConsole.exe MyCode.dll,MyCode.xml -Documenter=MSDN-CHM

私自身、このための外部ツールを作成し、それにショートカットを与えましたが、前の投稿者が言ったように、ビルド後のイベントに接続することができます。

(PS 私は数年前から上記のセットアップを使用しており、非常に満足しています)

于 2008-10-17T11:09:59.890 に答える