方法: ドキュメント生成のための XML コメントを挿入するHow to: Insert XML comments for documentation generation

Visual Studio では、クラスやメソッドなどのコード要素を文書化しやすいように、標準的な XML ドキュメント コメント構造を自動的に生成できます。Visual Studio can help you document code elements such as classes and methods, by automatically generating the standard XML documentation comment structure. コンパイル時に、ドキュメントのコメントを含む XML ファイルを生成できます。At compile time, you can generate an XML file that contains the documentation comments.

ヒント

生成された XML ファイルの場所と名前を構成する方法については、「XML コメントによるコードの文書化 (C# ガイド)」をご覧ください。For information about configuring the name and location of the generated XML file, see Documenting your code with XML comments (C# Guide).

コンパイラによって生成された XML ファイルは、.NET アセンブリと共に配布できます。これにより、Visual Studio や他の IDE で、IntelliSense を使って型やメンバーに関する概要情報を表示できます。The compiler-generated XML file can be distributed alongside your .NET assembly so that Visual Studio and other IDEs can use IntelliSense to show quick information about types and members. さらに、DocFXSandcastle のようなツールを使用して XML ファイルを実行し、API リファレンスの Web サイトを生成することができます。Additionally, the XML file can be run through tools like DocFX and Sandcastle to generate API reference websites.

注意

XML ドキュメントのコメントを自動的に挿入する [コメントの挿入] コマンドは、C#Visual Basic で使うことができます。The Insert Comment command that automatically inserts XML documentation comments is available in C# and Visual Basic. ただし、C++ ファイルに XML ドキュメントのコメントを手動で挿入し、コンパイル時に XML ドキュメント ファイルを生成することもできます。However, you can manually insert XML documentation comments in C++ files and still generate XML documentation files at compile time.

コード要素の XML コメントを挿入するにはTo insert XML comments for a code element

  1. メソッドなど、ドキュメント化する要素の上にテキスト カーソルを置きます。Place your text cursor above the element you want to document, for example, a method.

  2. 次のいずれかの操作を行います。Do one of the following:

    • C# では「///」と入力し、Visual Basic では「'''」と入力しますType /// in C#, or ''' in Visual Basic

    • [編集] メニューから、 [IntelliSense] > [コメントの挿入] の順に選択しますFrom the Edit menu, choose IntelliSense > Insert Comment

    • コード要素の前面またはすぐ上に表示される右クリック メニューまたはコンテキスト メニューから、 [スニペット] > [コメントの挿入] の順に選択しますFrom the right-click or context menu on or just above the code element, choose Snippet > Insert Comment

    すぐに、XML テンプレートがコード要素の上に生成されます。The XML template is immediately generated above the code element. たとえば、メソッドのコメントを生成すると、 <summary> 要素、各パラメーターの <param> 要素、戻り値を文書化するための <returns> 要素が生成されます。For example, when commenting a method, it generates the <summary> element, a <param> element for each parameter, and a <returns> element to document the return value.

    XML コメント テンプレート - C#

    XML コメント テンプレート - Visual Basic

  3. 各 XML 要素の説明を入力し、コード要素を完全に文書化します。Enter descriptions for each XML element to fully document the code element.

    完了したコメントを示すスクリーンショット。

要素の上にカーソルを置くとクイック ヒントに表示される、XML コメントのスタイルを使用できます。You can use styles in XML comments that will render in Quick Info when hovering over the element. これらのスタイルには、斜体、太字、箇条書き、クリック可能なリンクなどがあります。These styles include: italics, bold, bullets, and a clickable link.

斜体、太字、箇条書き、クリック可能なリンクのスタイル タグを含む完了したコメントを示すスクリーンショット。

注意

/// (C#) または ''' (Visual Basic) を入力した後で XML ドキュメントのコメントを切り替えるためのオプションがあります。There is an option to toggle XML documentation comments after typing /// in C# or ''' Visual Basic. メニュー バーから [ツール] > [オプション] の順に選択して、 [オプション] ダイアログ ボックスを開きます。From the menu bar, choose Tools > Options to open the Options dialog box. 次に、 [テキスト エディター] > [C#] または [Basic] > [詳細] の順に移動します。Then, navigate to Text Editor > C# or Basic > Advanced. [エディターのヘルプ] セクションで、 [XML ドキュメントを生成する] オプションを探します。In the Editor Help section, look for the Generate XML documentation comments option.

参照See also