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

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

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

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

注意

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

このセクションの内容

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