<returns> Dokumentationstag

  • Artikel

Das <returns>-Tag sollte im Kommentar für eine Methodendeklaration verwendet werden, um den Rückgabewert zu beschreiben.

Syntax

/// <returns>description</returns>

Parameter

description
Eine Beschreibung des Rückgabewerts.

Hinweise

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

Beispiel

// xml_returns_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_returns_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <returns>Returns zero.</returns>
   int GetZero() { return 0; }
};

Siehe auch

XML-Dokumentation