<paramref> tag dokumentacji

Tag <paramref> umożliwia wskazanie, że słowo jest parametrem. Plik XML można przetworzyć w celu sformatowania tego parametru w odrębny sposób.

Składnia

/// <paramref name="ref-name"/>

Parametry

ref-name
Nazwa parametru do odwoływania się do. Ujęć nazwę w pojedynczych lub podwójnych cudzysłowach. Kompilator wyświetla ostrzeżenie, jeśli nie znajdzie ref-nameelementu .

Uwagi

Skompiluj element , /doc aby przetworzyć komentarze dokumentacji do pliku.

Przykład

// xml_paramref_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_paramref_tag.dll
/// Text for class MyClass.
public ref class MyClass {
   /// <summary>MyMethod is a method in the MyClass class.
   /// The <paramref name="Int1"/> parameter takes a number.
   /// </summary>
   void MyMethod(int Int1) {}
};

Zobacz też

Dokumentacja XML