Vorgehensweise: Verwenden der XML-DokumentationsfeaturesHow to: Use the XML documentation features

Das folgende Beispiel bietet eine grundlegende Übersicht über einen Typ, der dokumentierten wurde.The following sample provides a basic overview of a type that has been documented.

BeispielExample

// If compiling from the command line, compile with: -doc:YourFileName.xml

/// <summary>
/// Class level summary documentation goes here.
/// </summary>
/// <remarks>
/// Longer comments can be associated with a type or member through
/// the remarks tag.
/// </remarks>
public class TestClass : TestInterface
{
    /// <summary>
    /// Store for the Name property.
    /// </summary>
    private string _name = null;

    /// <summary>
    /// The class constructor.
    /// </summary>
    public TestClass()
    {
        // TODO: Add Constructor Logic here.
    }

    /// <summary>
    /// Name property.
    /// </summary>
    /// <value>
    /// A value tag is used to describe the property value.
    /// </value>
    public string Name
    {
        get
        {
            if (_name == null)
            {
                throw new System.Exception("Name is null");
            }
            return _name;
        }
    }

    /// <summary>
    /// Description for SomeMethod.
    /// </summary>
    /// <param name="s"> Parameter description for s goes here.</param>
    /// <seealso cref="System.String">
    /// You can use the cref attribute on any tag to reference a type or member 
    /// and the compiler will check that the reference exists.
    /// </seealso>
    public void SomeMethod(string s)
    {
    }

    /// <summary>
    /// Some other method.
    /// </summary>
    /// <returns>
    /// Return values are described through the returns tag.
    /// </returns>
    /// <seealso cref="SomeMethod(string)">
    /// Notice the use of the cref attribute to reference a specific method.
    /// </seealso>
    public int SomeOtherMethod()
    {
        return 0;
    }

    public int InterfaceMethod(int n)
    {
        return n * n;
    }

    /// <summary>
    /// The entry point for the application.
    /// </summary>
    /// <param name="args"> A list of command line arguments.</param>
    static int Main(System.String[] args)
    {
        // TODO: Add code to start application here.
        return 0;
    }
}

/// <summary>
/// Documentation that describes the interface goes here.
/// </summary>
/// <remarks>
/// Details about the interface go here.
/// </remarks>
interface TestInterface
{
    /// <summary>
    /// Documentation that describes the method goes here.
    /// </summary>
    /// <param name="n">
    /// Parameter n requires an integer argument.
    /// </param>
    /// <returns>
    /// The method returns an integer.
    /// </returns>
    int InterfaceMethod(int n);
}

Im Beispiel wird eine XML-Datei mit folgendem Inhalt generiert:The example generates an .xml file with the following contents:

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>xmlsample</name>
    </assembly>
    <members>
        <member name="T:TestClass">
            <summary>
            Class level summary documentation goes here.
            </summary>
            <remarks>
            Longer comments can be associated with a type or member through
            the remarks tag.
            </remarks>
        </member>
        <member name="F:TestClass._name">
            <summary>
            Store for the Name property.
            </summary>
        </member>
        <member name="M:TestClass.#ctor">
            <summary>
            The class constructor.
            </summary>
        </member>
        <member name="P:TestClass.Name">
            <summary>
            Name property.
            </summary>
            <value>
            A value tag is used to describe the property value.
            </value>
        </member>
        <member name="M:TestClass.SomeMethod(System.String)">
            <summary>
            Description for SomeMethod.
            </summary>
            <param name="s"> Parameter description for s goes here.</param>
            <seealso cref="T:System.String">
            You can use the cref attribute on any tag to reference a type or member 
            and the compiler will check that the reference exists.
            </seealso>
        </member>
        <member name="M:TestClass.SomeOtherMethod">
            <summary>
            Some other method.
            </summary>
            <returns>
            Return values are described through the returns tag.
            </returns>
            <seealso cref="M:TestClass.SomeMethod(System.String)">
            Notice the use of the cref attribute to reference a specific method.
            </seealso>
        </member>
        <member name="M:TestClass.Main(System.String[])">
            <summary>
            The entry point for the application.
            </summary>
            <param name="args"> A list of command line arguments.</param>
        </member>
        <member name="T:TestInterface">
            <summary>
            Documentation that describes the interface goes here.
            </summary>
            <remarks>
            Details about the interface go here.
            </remarks>
        </member>
        <member name="M:TestInterface.InterfaceMethod(System.Int32)">
            <summary>
            Documentation that describes the method goes here.
            </summary>
            <param name="n">
            Parameter n requires an integer argument.
            </param>
            <returns>
            The method returns an integer.
            </returns>
        </member>
    </members>
</doc>

Kompilieren des CodesCompiling the code

Geben Sie die folgende Befehlszeile ein, um das Beispiel zu kompilieren:To compile the example, type the following command line:

csc XMLsample.cs /doc:XMLsample.xml

Mit diesem Befehl wird die XML-Datei XMLsample.xml erstellt, den Sie in Ihrem Browser oder mithilfe des TYPE-Befehls anzeigen können.This command creates the XML file XMLsample.xml, which you can view in your browser or by using the TYPE command.

Stabile ProgrammierungRobust programming

XML-Dokumentation beginnt mit ///.XML documentation starts with ///. Wenn Sie ein neues Projekt erstellen, fügt der Assistent einige ///-Startzeilen für Sie ein.When you create a new project, the wizards put some starter /// lines in for you. Die Verarbeitung dieser Kommentare weist einige Einschränkungen auf:The processing of these comments has some restrictions:

  • Die Dokumentation muss wohlgeformtes XML sein.The documentation must be well-formed XML. Wenn das XML nicht wohlgeformt ist, wird eine Warnung generiert, und die Dokumentationsdatei enthält einen Kommentar, der besagt, dass ein Fehler aufgetreten ist.If the XML is not well-formed, a warning is generated and the documentation file will contain a comment that says that an error was encountered.

  • Entwickler können ihren eigenen Satz von Tags erstellen.Developers are free to create their own set of tags. Es gibt eine Reihe empfohlener Tags (siehe Empfohlene Tags für Dokumentationskommentare).There is a recommended set of tags (see Recommended tags for documentation comments). Einige der empfohlenen Tags haben eine besondere Bedeutung:Some of the recommended tags have special meanings:

    • Das <param>-Tag wird verwendet, um Parameter zu beschreiben.The <param> tag is used to describe parameters. Wenn es verwendet wird, überprüft der Compiler, ob der Parameter vorhanden ist, und ob alle Parameter in der Dokumentation beschrieben werden.If used, the compiler verifies that the parameter exists and that all parameters are described in the documentation. Wenn die Überprüfung fehlschlägt, gibt der Compiler eine Warnung aus.If the verification failed, the compiler issues a warning.

    • Das cref-Attribut kann an jedes Tag angefügt werden, um einen Verweis auf ein Codeelement bereitzustellen.The cref attribute can be attached to any tag to provide a reference to a code element. Der Compiler überprüft, ob dieses Codeelement vorhanden ist.The compiler verifies that this code element exists. Wenn die Überprüfung fehlschlägt, gibt der Compiler eine Warnung aus.If the verification failed, the compiler issues a warning. Der Compiler berücksichtigt alle using-Anweisungen, wenn er nach einem Typ sucht, der im cref-Attribut beschrieben wird.The compiler respects any using statements when it looks for a type described in the cref attribute.

    • Das <summary>-Tag wird von IntelliSense in Visual Studio verwendet, um zusätzliche Informationen über einen Typ oder Member anzuzeigen.The <summary> tag is used by IntelliSense inside Visual Studio to display additional information about a type or member.

      Hinweis

      Die XML-Datei enthält keine vollständigen Informationen über den Typ und die Member (z. B. fehlen Typinformationen).The XML file does not provide full information about the type and members (for example, it does not contain any type information). Um vollständige Informationen zu einem Typ oder Member zu erhalten, muss die Dokumentationsdatei zusammen mit Reflektion über den tatsächlichen Typ oder Member verwendet werden.To get full information about a type or member, the documentation file must be used together with reflection on the actual type or member.

Siehe auchSee also

C#-ProgrammierhandbuchC# Programming Guide
/doc (C#-Compileroptionen)/doc (C# Compiler Options)
XML-DokumentationskommentareXML Documentation Comments