Sdílet prostřednictvím

<param> značka dokumentace

  • Článek

Značka <param> by měla být použita v komentáři pro deklaraci metody popisovat jeden z parametrů metody.

Syntaxe

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

Parametry

param-name
Název parametru metody. Uzavřete název do jednoduchých nebo dvojitých uvozovek. Kompilátor vydá upozornění, pokud ho nenajde param-name.

description
Popis parametru.

Poznámky

Text značky <param> se zobrazí v IntelliSense, prohlížeči objektů a ve webové sestavě komentáře kódu.

Zkompilujte je /doc pro zpracování komentářů dokumentace k 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é

Dokumentace XML