Freigeben über


<paramref> (Visual C++)

Das <paramref>-Tag gibt Ihnen die Möglichkeit, anzugeben, dass ein Wort ein Parameter ist.Die XML-Datei kann verarbeitet werden, um diesen Parameter auf eine andere Weise zu formatieren.

<paramref name="name"/>

Parameter

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

Hinweise

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

Beispiel

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

Siehe auch

Weitere Ressourcen

XML Documentation (Visual C++)