Freigeben über


<param> (Visual C++)

Das <param>-Tag sollte im Kommentar für eine Methodendeklaration verwendet werden, um einen der Parameter der Methode zu beschreiben.

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

Parameter

  • name
    der Name des Methodenparameters.Fügen Sie den Namen in einfache oder doppelte Anführungszeichen eingeschlossen werden.Der Compiler gibt eine Warnung aus, wenn nicht name sucht.

  • description
    eine Beschreibung für den Parameter.

Hinweise

Der Text für das <param>-Tag wird in IntelliSense, Objektkatalog und im Webbericht über Codekommentare angezeigt.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit "/doc" kompiliert werden.

Beispiel

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

Siehe auch

Weitere Ressourcen

XML Documentation (Visual C++)