<param> (C# プログラミング ガイド)
更新 : 2007 年 11 月
<param name='name'>description</param>
パラメータ
name
メソッド パラメータの名前。名前は、二重引用符 (" ") で囲みます。description
パラメータの説明。
解説
<param> タグは、メソッド宣言のコメント内で使用してメソッドのパラメータの 1 つを説明します。
<param> タグのテキストは、IntelliSense、オブジェクト ブラウザ、およびコード コメント Web レポートに表示されます。
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
// compile with: /doc:DocFileName.xml
/// text for class TestClass
public class TestClass
{
/// <param name="Int1">Used to indicate status.</param>
public static void DoWork(int Int1)
{
}
/// text for Main
static void Main()
{
}
}