問題タブ [sandcastle]

Visual Studio 2008 でプロジェクトのクラス図を作成し、Sandcastle を使用してこれらの図を埋め込みました。

例：

*サンドキャッスルの文書化されたクラス ライブラリ

Biol..::..f_BiolabTestSayisi メソッド
Biol クラス 関連項目 フィードバックの送信

名前空間: TR.Biolアセンブリ : TR (TR.dll 内) バージョン: 1.0.0.0 (1.0.0.0)

構文

C# public static DataSet f_BiolTestSayisi()

ビジュアルベーシック

Public Shared Function f_BiolTestSayisi As DataSet

ビジュアル C++

public: static DataSet^ f_BiolTestSayisi()

戻り値 [「M:TR.Biol.Biol.f_BioTestSayi」のドキュメントがありません]*

プロジェクト内のすべてのクラスは、サンドキャッスル ドキュメント クラス ライブラリで確認できます。メソッドのプロトタイプとボディも見たいです。どうすれば入手できますか？

前もって感謝します。

sandcasle を使用している人は誰でも..i は、それを使用して、使いやすいヘルプ ファイルを生成する msbuild プロジェクト設定を作成するために一歩一歩進んだものを見つけることができませんでした。コードプレックスからインストールし、ファイルビルダーをインストールしましたが、使用方法が明確に述べられていません。どんな例でも適用されます。

依存関係プロパティを文書化する最良の方法は何ですか?

フィールドにxmlドキュメントを配置する必要があります:

またはプロパティで：

または、両方を文書化 (および維持) する必要がありますか?

サンドキャッスルのダウンロードページはこちらです。MSI をダウンロードしてインストールすると、プログラム ファイル (x86) 内にディレクトリが生成されますが、開始時にメニュー項目がなく、「開始」もありません。レビュー コメントでは、解決策はソース アーカイブもダウンロードしてそこにある MSI を見つけることであると主張していますが、ソース アーカイブ内に MSI が表示されません。手続きは？

SandCastle を使用して、最新のプロジェクトのヘルプ ドキュメントを生成しようとしています。ユーティリティ プロジェクトではすべて問題なく動作しましたが、メイン プロジェクトで使用しようとすると、Crystal Reports でエラーが発生します。

すべてのCrystal Reportsファイルを完全に除外する方法、または何らかの修正を行う方法を知っている人はいますか?

私の方法は次のようになります

しかし、Sandcastle を実行すると、ドキュメントは次のようになります。

ユーザー ID タイプ: System..::..Int32

[「M:myapp.Core.Domain.ActivityLogService.AddActivity(System.Int32,System.Int32,System.String)」のドキュメントがありません]

アクティビティの種類: System..::..Int32

[「M:myapp.Core.Domain.ActivityLogService.AddActivity(System.Int32,System.Int32,System.String)」のドキュメントがありません]

IP タイプ: System..::..String

[「M:myapp.Core.Domain.ActivityLogService.AddActivity(System.Int32,System.Int32,System.String)」のドキュメントがありません]

私は何を間違っていますか？

Sandcastleを使用して、既存のトピックファイル（.AML）からヘルプドキュメントを生成できるようにしたいと考えています。Sandcastle Help File Builderを使用して、ドキュメントの構成と生成を支援します。

コードドキュメントを公開したくありませんが、ドキュメントソース（プロジェクト、ソリューション、dll、exeなど）を指定しないと、ビルドが失敗します。

コードドキュメントを公開せずにドキュメントを生成できるように、Sandcastleヘルプファイルビルダーを構成するにはどうすればよいですか？

WiXを使用してSandcastleプロジェクトのビルド後にSandcastleヘルプファイルビルダーが作成するHelpLibraryManagerLauncherを実行することにより、自分のヘルプファイルをVisualStudio2010のヘルプライブラリに追加しようとしています。

WiXのQuietExecカスタムアクションを使用して、次のコマンドを実行しています。

ただし、MSIインストーラーは次の場合に失敗します。

EventLogを確認すると、次のエラーが記録されます。

これが私のWiXコードです：

HelpLibraryManagerLauncherコマンドプロンプトからを実行すると、操作は正常に完了したと表示されますが、ヘルプライブラリを確認すると、ヘルプライブラリがインストールされていません。

ただし、スイッチを削除する/silentと、通常の[ヘルプライブラリマネージャー]ウィンドウがポップアップし、ヘルプライブラリが一覧表示されます。

もちろん、ヘルプライブラリマネージャーのGUIを操作せずに、WiXからヘルプファイルを自動的にインストールできるようにしたいのですが、何かが足りないはずです。コマンドプロンプトまたはWiXを使用して、ヘルプファイルをサイレントインストールすることはできませんか？（ただし、コマンドプロンプトからサイレントにアンインストールすることは問題なく機能します）。

これCacheLibUnsignedInstallRefusedExceptionも懸念事項です。署名されていない場合でも、WiX（およびMSI）にヘルプファイルをインストールさせるにはどうすればよいですか？

WiX v3.5.2415、Sandcastle v2.610621.1、およびSandcastle Help FileBuilderv1.9.1.0を使用しています。Sandcastle HelpFileBuilderが使用するHelp2.0コンパイラとHTMLHelpWorkshop hhc実行可能ファイルは、Visual Studio2008SDKからのものです。

どんな助けでも大歓迎です。

VS2010XMLドキュメントからHTML/ヘルプファイルを作成するための優れたツールを探しています。私は次のようないくつかの商用ツールを見つけました

• .Netドキュメントツール
• VSDocman

もっとたくさんあると思います。例としてこれら2つをリストします。また、XMLをHTMLドキュメントに変換するための単純なXSLTスタイルシートがあります。

何を使用していますか。たとえば、アドインとして、変換を行うための無料のツールがあります。明確にするために、基本的に私は2つのタイプのツールを見つけました：

1. XMLドキュメントファイルをさまざまなターゲット形式に変換するもの、これが私が探しているものです。
2. ソースコードでXMLドキュメントを生成するのに役立つツール。これは私が探しているものではありません（！）。

ご協力いただきありがとうございます。

サンドキャッスル/SHFBコンボは素晴らしい働きをします。助けてくれたすべての人に感謝します。

いくつかの意見：

1. NDocは古くなっているようです。最後の更新は2005年のものです。そのため、これをスキップしました。
2. 同様のスレッドも非常に詳細です。https ：//stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something-usefulヒントをありがとうございます。
3. Sandcastleにはいくつかのソースがあり、私が見つけた最新バージョンはここにあります：http ://sandcastle.codeplex.com/
4. 生成するMsHelp2には、を含むVS2008SDKをインストールする必要がありましたhscomp.exe。バージョン1.0にはコンパイラが含まれていることがわかる限り、バージョン1.0と1.1があります。詳細については、 HelixsoftおよびSocialMSDNを参照してください。
5. 私の場合、生成されたWebHelpはChromeで正しく機能しません。常にindex.htmlページをリロードします。
6. ここのトピックは、名前空間情報をサンドキャッスルドキュメントに追加する方法を示しています。
7. 2012年11月現在の更新：小規模なプロジェクトでは、Doxygenを使用しています-構成が少し簡単だと思います。

Sandcastleを使用してAPIドキュメントを作成しています。コードには、非推奨とマークされた複数のクラスとメソッドがあります。ここで、APIドキュメントの出力で、これらのメソッドが明確にマークされていることを確認します（取り消し線またはその他のマーカー）。ただし、Sandcastleの出力は、廃止されたメソッド/クラスをまったくマークしません。

私の質問はです。廃止されたメソッド/クラスをSandcastleでマークするには、何をする必要がありますか。

アドバイス/ヘルプをありがとう。