<param> (Visual C++)
<param> タグは、メソッド宣言のコメント内で使用してメソッドのパラメーターの 1 つを説明します。
<param name='name'>description</param>
パラメーター
name
メソッド パラメーターの名前。単一引用符で囲みます。コンパイラは nameを検索警告が発行されます。description
パラメーターの説明。
解説
<param> のタグのテキストは、IntelliSense、[オブジェクト ブラウザー]、コード コメント Web レポートで表示されます。
コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。
使用例
// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <param name="Int1">Used to indicate status.</param>
void MyMethod(int Int1) {
}
};