<summary> (C#-Programmierhandbuch)

<summary>description</summary>

Parameter

• description
  eine Zusammenfassung des Objekts.

Hinweise

Das <summary>-Tag sollte verwendet werden, um einen Typ oder einen Typmember zu beschreiben. Mit <remarks> können Sie zusätzliche Informationen zu einer Typbeschreibung angeben. Aktivieren Sie Dokumentationstools wie Sandcastle mit dem cref-Attribut, um interne Links zu Dokumentationsseiten für Codeelemente zu erstellen.

Der Text für das <summary>-Tag ist die einzige Informationsquelle über den Typ in IntelliSense und wird auch im Objektkatalog angezeigt.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit "/doc" kompiliert werden. Zum Erstellen der endgültigen Dokumentation auf Grundlage der vom Compiler generierten Datei können Sie ein benutzerdefiniertes Tool erstellen oder ein Tool wie Sandcastle verwenden.

Beispiel

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

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

Im folgenden Beispiel wird veranschaulicht, wie ein cref-Verweis auf einen generischen Typ erstellt wird.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
// <summary cref="C &lt; T &gt;">

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

Siehe auch

Referenz

Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)

Konzepte

C#-Programmierhandbuch