Sdílet prostřednictvím


<param> (Visual C++)

<param> značky by měl být používán pro deklaraci metody Poznámka popisující parametry pro metodu.

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

Parametry

  • name
    Název parametru metody.Název uzavřete do jednoduchých nebo dvojitých uvozovek.Kompilátor vydá upozornění, pokud se nenajde name.

  • description
    Popis parametru.

Poznámky

Text pro <param> značky se zobrazí v technologii IntelliSense, Prohlížeč objektůa v kódu komentář webové sestavy.

Kompilace s /doc k procesu dokumentační komentáře do souboru.

Příklad

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

Viz také

Další zdroje

XML dokumentace (Visual C++)