Sdílet prostřednictvím


<paramref> značka dokumentace

Značka <paramref> poskytuje způsob, jak označit, že slovo je parametr. Soubor XML lze zpracovat tak, aby formátoval tento parametr určitým způsobem.

Syntaxe

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

Parametry

ref-name
Název parametru, na který se má odkazovat. Uzavřete název do jednoduchých nebo dvojitých uvozovek. Kompilátor vydá upozornění, pokud ho nenajde ref-name.

Poznámky

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad

// 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) {}
};

Viz také

Dokumentace XML