<example> (Visual C++)
<example> タグでは、メソッドやその他のライブラリ メンバーの使用例を指定します。一般に、これは <code> のタグの使用します。
<example>description</example>
パラメーター
- description
サンプル コードの説明。
解説
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
// xml_example_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_example_tag.dll
/// Text for class MyClass.
public ref class MyClass {
public:
/// <summary>
/// GetZero method
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// int main()
/// {
/// return GetZero();
/// }
/// </code>
/// </example>
static int GetZero() {
return 0;
}
};