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

Visual C# では、ソース コード内で、コード ブロックの直前の特別なコメント フィールド (3 個のスラッシュで示す) に XML 要素を配置することで、コードのドキュメントを作成できます。例を次に示します。In Visual C# you can create documentation for your code by including XML elements in special comment fields (indicated by triple slashes) in the source code directly before the code block to which the comments refer, for example:

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

/doc オプションを使用してコンパイルすると、コンパイラは、ソース コード内のすべての XML タグを検索して、XML ドキュメント ファイルを作成します。When you compile with the /doc option, the compiler will search for all XML tags in the source code and create an XML documentation file. コンパイラによって生成されたファイルに基づいて最終的なドキュメントを作成するには、カスタム ツールを作成するか、Sandcastle などのツールを使用します。To create the final documentation based on the compiler-generated file, you can create a custom tool or use a tool such as Sandcastle.

XML 要素を参照するには (たとえば、XML ドキュメント コメントに記述する特定の XML 要素を関数で処理する場合)、標準の引用のしくみを使用できます (<>)。To refer to XML elements (for example, your function processes specific XML elements that you want to describe in an XML documentation comment), you can use the standard quoting mechanism (< and >). コード参照 (cref) 要素でジェネリック識別子を参照するには、エスケープ文字 (たとえば、cref="List&lt;T&gt;") または中かっこ (cref="List{T}") を使用できます。To refer to generic identifiers in code reference (cref) elements, you can use either the escape characters (for example, cref="List&lt;T&gt;") or braces (cref="List{T}"). 特殊なケースとして、コンパイラは中かっこを山かっことして解析し、ジェネリック識別子を参照するときにドキュメント コメントの編集があまり面倒にならないようにしています。As a special case, the compiler parses the braces as angle brackets to make the documentation comment less cumbersome to author when referring to generic identifiers.


XML ドキュメント コメントはメタデータではなく、コンパイルされたアセンブリに含まれないため、リフレクションでアクセスできません。The XML documentation comments are not metadata; they are not included in the compiled assembly and therefore they are not accessible through reflection.

このセクションの内容In This Section

詳細については次を参照してください:For more information, see:

C# 言語仕様C# Language Specification

詳細については、「C# 言語の仕様」を参照してください。For more information, see the C# Language Specification. 言語仕様は、C# の構文と使用法に関する信頼性のある情報源です。The language specification is the definitive source for C# syntax and usage.

参照See Also