<summary> (Visual C++)
<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() {}
};