c# - c# dll にコンテキスト ヘルプを実装して、設計時に使用する

Question

私は c# でいくつかの dll ライブラリを開発しました。このリンクで表示されるスクリーンショットのように、顧客が私のライブラリのメソッドとイベントを呼び出すときに、設計時に表示されるコンテキスト ヘルプをプロジェクトに挿入する可能性があるかどうかを知る必要があります。

全体画像はこちら

これを行うことは可能ですか？アイデア？みんな本当にありがとう

ジャンピアによって

Answer 1

といいXML Docsます。基本的な構文は次のとおりです。

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{ }

• XML ドキュメントのコメント
• おすすめタグ

Answer 2

ドキュメントは、xml コメントを使用してコードで作成されます。

/// <summary>
/// This text will show up in the contextual help box.
/// </summary>
public void SomePublicMethod() {
    ...
}

このメタデータを含む dll を出荷するには、xml ドキュメントを生成します。

Visual C# プロジェクトの XML ドキュメント ファイルを生成するには ソリューション エクスプローラーでプロジェクトを選択し、[プロジェクト] メニューの [プロパティ] をクリックします。[ビルド] タブをクリックします。[ビルド] ページで、XML ドキュメント ファイルを選択します。既定では、ファイルは指定された出力パス ("bin\Debug\Projectname.XML" など) の下に作成されます。

Answer 3

クラス、プロパティ、およびメソッドに XML コード コメントを追加する必要があります。アプリをビルドするときは、Xml ドキュメント ファイルの [ビルド] オプションを確認してください。次に、xml ファイルを DLL と共に配布します。

Visual Studio では、コード要素 (クラス、プロパティ、列挙型、メソッド) の前の行に /// と入力すると、適切なコメント スタブが追加されます。