次の方法で共有


XML ドキュメント コメント (C# プログラミング ガイド)

Visual C# では、ソース コード内で、参照先のコード ブロックの直前の特別なコメント フィールドに XML タグを配置することで、コードのドキュメントを作成できます。 次に例を示します。

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

/doc を使用してコンパイルすると、コンパイラは、ソース コードですべての XML タグを検索し、XML ドキュメント ファイルを作成します。 コンパイラによって生成されたファイルに基づいて最終的なドキュメントを作成するには、カスタム ツールを作成するか、Sandcastle などのツールを使用します。

注意

XML ドキュメント コメントはメタデータでなく、コンパイルされたアセンブリに含まれないため、リフレクションでアクセスできません。

このセクションの内容

関連項目

詳細については、次のトピックを参照してください。

C# 言語仕様

詳細については、「C# 言語仕様」を参照してください。 言語仕様は、C# の構文と使用法に関する信頼性のある情報源です。

参照

概念

C# プログラミング ガイド