<returns> (C#-Programmierhandbuch)<returns> (C# Programming Guide)

SyntaxSyntax

<returns>description</returns>  

ParameterParameters

description
Eine Beschreibung des Rückgabewerts.A description of the return value.

HinweiseRemarks

Das <returns>-Tag sollte im Kommentar für eine Methodendeklaration verwendet werden, um den Rückgabewert zu beschreiben.The <returns> tag should be used in the comment for a method declaration to describe the return value.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.Compile with /doc to process documentation comments to a file.

BeispielExample

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <returns>Returns zero.</returns>
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main
    static void Main()
    {
    }
}

Siehe auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments