Freigeben über

<paramref> Dokumentationstag

  • Artikel

Das Tag <paramref> ermöglicht Ihnen, anzugeben, dass ein Wort ein Parameter ist. Die XML-Datei kann verarbeitet werden, um diesen Parameter auf verschiedene Weisen zu formatieren.

Syntax

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

Parameter

ref-name
Der Name des Parameters, auf den verwiesen wird. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen. Der Compiler gibt eine Warnung aus, wenn er nicht gefunden ref-namewird.

Hinweise

Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.

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

XML-Dokumentation