Freigeben über

<param> Dokumentationstag

  • Artikel

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

Syntax

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

Parameter

param-name
Der Name eines Methodenparameters. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen. Der Compiler gibt eine Warnung aus, wenn er nicht gefunden param-namewird.

description
Eine Beschreibung für den Parameter

Hinweise

Der Text für das <param> Tag wird in IntelliSense, dem Objektbrowser und im Codekommentar-Webbericht angezeigt.

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

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

XML-Dokumentation