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

SyntaxSyntax

<paramref name="name"/>  

ParameterParameters

name
Der Name des Parameters, auf den verwiesen wird.The name of the parameter to refer to. Setzen Sie den Namen in doppelte Anführungszeichen (" ").Enclose the name in double quotation marks (" ").

HinweiseRemarks

Das Tag <paramref> bietet Ihnen eine Möglichkeit anzugeben, dass sich ein Wort in den Codekommentaren, z.B. in einem <summary>- oder <remarks>-Block, auf einen Parameter bezieht.The <paramref> tag gives you a way to indicate that a word in the code comments, for example in a <summary> or <remarks> block refers to a parameter. Die XML-Datei kann so verarbeitet werden, dass dieses Wort anders formatiert wird, z.B. fett oder kursiv.The XML file can be processed to format this word in some distinct way, such as with a bold or italic font.

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
{
    /// <summary>DoWork is a method in the TestClass class.  
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

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

Siehe auchSee Also

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