Fonctions des extraits de codeCode Snippet functions

Trois fonctions peuvent être utilisées avec les extraits de code C#.There are three functions available to use with C# code snippets. Les fonctions sont spécifiées dans l’élément Function de l’extrait de code.Functions are specified in the Function element of the code snippet. Pour plus d’informations sur la création d’extraits de code, consultez Extraits de code.For information on creating code snippets, see Code Snippets.

FonctionsFunctions

Le tableau suivant décrit les fonctions qui peuvent être utilisées avec l’élément Function dans les extraits de code.The following table describes the functions available for use with the Function element in code snippets.

FonctionFunction DescriptionDescription LangueLanguage
GenerateSwitchCases( EnumerationLiteral )GenerateSwitchCases( EnumerationLiteral ) Génère une instruction switch et un ensemble d’instructions case pour les membres de l’énumération spécifiée par le paramètre EnumerationLiteral.Generates a switch statement and a set of case statements for the members of the enumeration specified by the EnumerationLiteral parameter. Le paramètre EnumerationLiteral doit être une référence à un littéral d’énumération ou un type d’énumération.The EnumerationLiteral parameter must be either a reference to an enumeration literal or an enumeration type. Visual C#Visual C#
ClassName() Retourne le nom de la classe qui contient l’extrait de code inséré.Returns the name of the class that contains the inserted snippet. Visual C#Visual C#
SimpleTypeName( TypeName )SimpleTypeName( TypeName ) Réduit le paramètre TypeName à sa forme la plus simple dans le contexte dans lequel l’extrait de code a été appelé.Reduces the TypeName parameter to its simplest form in the context in which the snippet was invoked. Visual C#Visual C#

ExempleExample

L'exemple suivant montre comment utiliser la fonction GenerateSwitchCases.The following example shows how to use the GenerateSwitchCases function. Quand cet extrait de code est inséré et qu’une énumération est entrée dans le littéral $switch_on$, le littéral $cases$ génère une instruction case pour chaque valeur contenue dans l’énumération.When this snippet is inserted and an enumeration is entered into the $switch_on$ literal, the $cases$ literal generates a case statement for every value in the enumeration.

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
    <CodeSnippet Format="1.0.0">  
        <Header>  
            <Title>switch</Title>   
            <Shortcut>switch</Shortcut>   
            <Description>Code snippet for switch statement</Description>   
            <Author>Microsoft Corporation</Author>   
            <SnippetTypes>  
                <SnippetType>Expansion</SnippetType>   
            </SnippetTypes>  
        </Header>  
        <Snippet>  
            <Declarations>  
                <Literal>  
                    <ID>expression</ID>   
                    <ToolTip>Expression to switch on</ToolTip>   
                    <Default>switch_on</Default>   
                </Literal>  
                <Literal Editable="false">  
                    <ID>cases</ID>   
                    <Function>GenerateSwitchCases($expression$)</Function>   
                    <Default>default:</Default>   
                </Literal>  
            </Declarations>  
            <Code Language="csharp">  
                <![CDATA[  
                    switch ($expression$)  
                    {  
                        $cases$  
                    }  
                ]]>  
            </Code>  
        </Snippet>  
    </CodeSnippet>  
</CodeSnippets>  

ExempleExample

L'exemple suivant montre comment utiliser la fonction ClassName.The following example shows how to use the ClassName function. Quand cet extrait de code est inséré, le littéral $classname$ est remplacé par le nom de la classe englobante à cet emplacement dans le fichier de code.When this snippet is inserted, the $classname$ literal is replaced with the name of the enclosing class at that location in the code file.

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
    <CodeSnippet Format="1.0.0">  
        <Header>  
            <Title>Common constructor pattern</Title>   
            <Shortcut>ctor</Shortcut>   
            <Description>Code Snippet for a constructor</Description>  
            <Author>Microsoft Corporation</Author>   
            <SnippetTypes>  
                <SnippetType>Expansion</SnippetType>  
            </SnippetTypes>  
        </Header>  
        <Snippet>  
            <Declarations>  
                <Literal>  
                    <ID>type</ID>   
                    <Default>int</Default>   
                </Literal>  
                <Literal>  
                    <ID>name</ID>   
                    <Default>field</Default>   
                </Literal>  
                <Literal default="true" Editable="false">  
                    <ID>classname</ID>   
                    <ToolTip>Class name</ToolTip>   
                    <Function>ClassName()</Function>   
                    <Default>ClassNamePlaceholder</Default>   
                </Literal>  
            </Declarations>  
            <Code Language="csharp" Format="CData">  
                <![CDATA[   
                    public $classname$ ($type$ $name$)  
                    {  
                        this._$name$ = $name$;  
                    }  
                    private $type$ _$name$;  
                ]]>  
            </Code>  
        </Snippet>  
    </CodeSnippet>  
</CodeSnippets>  

ExempleExample

Cet exemple montre comment utiliser la fonction SimpleTypeName.This example shows how to use the SimpleTypeName function. Quand cet extrait de code est inséré dans un fichier de code, le littéral $SystemConsole$ est remplacé par la forme la plus simple du type Console dans le contexte dans lequel l’extrait de code a été appelé.When this snippet is inserted into a code file, the $SystemConsole$ literal will be replaced with the simplest form of the Console type in the context in which the snippet was invoked.

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
    <CodeSnippet Format="1.0.0">  
        <Header>  
            <Title>Console_WriteLine</Title>   
            <Shortcut>cw</Shortcut>   
            <Description>Code snippet for Console.WriteLine</Description>   
            <Author>Microsoft Corporation</Author>   
            <SnippetTypes>  
                <SnippetType>Expansion</SnippetType>   
            </SnippetTypes>  
        </Header>  
        <Snippet>  
            <Declarations>  
                <Literal Editable="false">  
                    <ID>SystemConsole</ID>   
                    <Function>SimpleTypeName(global::System.Console)</Function>   
                </Literal>  
            </Declarations>  
            <Code Language="csharp">  
                <![CDATA[   
                    $SystemConsole$.WriteLine();  
                ]]>  
            </Code>  
        </Snippet>  
    </CodeSnippet>  
</CodeSnippets>  

Voir aussiSee also

Function, élémentFunction Element
Référence de schéma des extraits de codeCode Snippets Schema Reference