共用方式為

<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 檔