Fonctions des extraits de code

Mise à jour : novembre 2007

Il est possible d'utiliser trois fonctions avec les extraits de code en Visual C#. Les fonctions sont spécifiées dans l'élément Function, élément (extraits de code IntelliSense) de l'extrait de code. Pour plus d'informations sur la création d'extraits de code, consultez Création et utilisation d'extraits de code IntelliSense.

Fonctions

Le tableau suivant décrit les fonctions que vous pouvez utiliser avec l'élément Function dans les extraits de code.

Fonction	Description	Langage
GenerateSwitchCases(EnumerationLiteral)	Génère une instruction switch et un jeu d'instructions case pour les membres de l'énumération spécifiée par le paramètre EnumerationLiteral. Le paramètre EnumerationLiteral doit être soit une référence à un littéral d'énumération soit un type d'énumération.	Visual C#
ClassName()	Retourne le nom de la classe qui contient l'extrait inséré.	Visual C#
SimpleTypeName(TypeName)	Réduit le paramètre TypeName à sa forme la plus simple dans le contexte où l'extrait de code a été appelé.	Visual C#

Exemple

L'exemple suivant montre comment utiliser la fonction GenerateSwitchCases. Lorsque cet extrait de code est inséré et qu'une énumération est introduite dans le littéral $switch_on$, le littéral $cases$ génère une instruction case pour chaque valeur dans l'énumération.

<CodeSnippets xmlns="https://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>

L'exemple suivant montre comment utiliser la fonction ClassName. Lorsque 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.

<CodeSnippets xmlns="https://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="vjsharp" Format="CData">
                <![CDATA[ 
                    public $classname$ ($type$ $name$)
                    {
                        this._$name$ = $name$;
                    }
                    private $type$ _$name$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Cet exemple indique comment utiliser la fonction SimpleTypeName. Lorsque cet extrait de code est inséré dans un fichier de code, le littéral $SystemConsole$ sera remplacé par la forme la plus simple du type Console dans le contexte dans lequel l'extrait de code a été appelé.

<CodeSnippets xmlns="https://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 aussi

Concepts

Référence de schéma des extraits de code

Référence

Function, élément (extraits de code IntelliSense)