<param> ドキュメント タグ

<param> タグは、メソッドのいずれかのパラメーターを記述するために、メソッド宣言のコメントで使用する必要があります。

構文

/// <param name='param-name'>description</param>

パラメーター

param-name
メソッド パラメーターの名前です。 名前は、一重引用符または二重引用符で囲みます。 コンパイラでは、param-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) {
   }
};

関連項目

XML ドキュメント