<summary>
タグは、型または型メンバーの説明に使用します。 型の説明に補足情報を追加するには、<remarks>
を使用します。
構文
/// <summary>description</summary>
パラメーター
description
オブジェクトの概要。
解説
<summary>
タグのテキストは、IntelliSense の型に関する唯一のソースで、オブジェクト ブラウザーとコード コメント Web レポートにも表示されます。
コンパイル時に /doc
を指定して、ドキュメント コメントをファイルに出力します。
例
// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll
/// Text for class MyClass.
public ref class MyClass {
public:
/// <summary>MyMethod is a method in the MyClass class.
/// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
/// <seealso cref="MyClass::MyMethod2"/>
/// </summary>
void MyMethod(int Int1) {}
/// text
void MyMethod2() {}
};