<example> (C# プログラミング ガイド)
更新 : 2007 年 11 月
<example>description</example>
パラメータ
- description
サンプル コードの説明。
解説
<example> タグでは、メソッドやその他のライブラリ メンバの使用例を指定します。通常は、<code> タグも使用します。
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
// compile with: /doc:DocFileName.xml
/// text for class TestClass
public class TestClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class TestClass
/// {
/// static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
/// text for Main
static void Main()
{
}
}