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

SyntaxSyntax

<remarks>description</remarks>  

ParameterParameters

Description
Eine Beschreibung des MembersA description of the member.

HinweiseRemarks

Das Tag <remarks> wird verwendet, um Informationen zu einem Typ hinzuzufügen. Dadurch werden die mit <summary> angegebenen Informationen ergänzt.The <remarks> tag is used to add information about a type, supplementing the information specified with <summary>. Diese Informationen werden im Fenster des Objektkatalogs angezeigt.This information is displayed in the Object Browser window.

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 

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public class TestClass
{
    /// text for Main
    static void Main()
    {
    }
}

Siehe auchSee Also

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