Referenční informace ke schématu fragmentů kódu

  • Článek

Fragmenty kódu jsou předem autorizované části kódu, které jsou připravené k vložení do aplikace. Pomocí fragmentů kódu můžete zvýšit produktivitu a spolehlivost, abyste zkrátili dobu strávenou psaním opakujícího se kódu nebo hledáním ukázek.

Tento článek obsahuje odkaz na schéma XML fragmentu kódu IntelliSense sady Visual Studio. Pomocí schématu můžete vytvořit vlastní fragmenty kódu a přidat je do fragmentů kódu, které sada Visual Studio už obsahuje.

Assembly – element

Určuje název sestavení, na které se odkazuje fragment kódu.

Textová hodnota elementu Assembly je popisný textový název sestavení, například System.dll, nebo jeho silný název, například System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.

<Assembly>
    AssemblyName
</Assembly>
Nadřazený prvek Popis
Referenční prvek Obsahuje informace o odkazech na sestavení vyžadovaných fragmentem kódu.

Je vyžadována textová hodnota. Tento text určuje sestavení, na které se odkazuje fragment kódu.

Author – element

Určuje jméno autora fragmentu kódu. Správce fragmentů kódu zobrazí název uložený v Author prvku fragmentu kódu.

<Author>
   Code Snippet Author
</Author>
Nadřazený prvek Popis
Header – element Obsahuje obecné informace o fragmentu kódu.

Je vyžadována textová hodnota. Tento text určuje autora fragmentu kódu.

Prvek kódu

Poskytuje kontejner pro krátké bloky kódu.

Klíčová slova

Dvě vyhrazená slova jsou k dispozici pro použití v textu Code prvku: $end$ a $selected$. $end$ označí umístění pro umístění kurzoru za vložením fragmentu kódu. $selected$ představuje vybraný text dokumentu, který se má vložit do fragmentu kódu při vyvolání fragmentu. Například s ohledem na fragment kódu, který zahrnuje:

$selected$ is a great color.

Pokud je slovo Blue vybráno při vyvolání fragmentu kódu uživatelem, výsledkem je:

Blue is a great color.

V fragmentu kódu nesmíte použít ani $end$ $selected$ více než jednou. Pokud ano, rozpozná se pouze druhá instance. Vzhledem k fragmentu kódu, který zahrnuje:

$selected$ is a great color. I love $selected$.

Pokud je slovo Blue vybrané, výsledek je:

 is a great color. I love Blue.

Počáteční mezera se zobrazí, protože mezi $selected$ a is.

Všechna ostatní $ klíčová slova jsou dynamicky definovaná v těchto <Literal> značkách a <Object> značkách.

Následující kód ukazuje strukturu elementu Code :

<Code Language="Language"
    Kind="method body/method decl/type decl/page/file/any"
    Delimiter="Delimiter">
    Code to insert
</Code>

Je vyžadována textová hodnota. Tento text určuje kód spolu s literály a objekty, které můžete použít při vložení tohoto fragmentu kódu do souboru kódu.

Atributy

Pro element jsou k dispozici Code tři atributy:

  • Jazyk. Povinný atribut, který určuje jazyk fragmentu kódu. Hodnota musí být jedna z následujících hodnot:

    Hodnota Popis
    VB Fragment kódu jazyka Visual Basic
    CSharp Fragment kódu jazyka C#.
    CPP Fragment kódu C++.
    XAML Fragment kódu XAML
    XML Fragment kódu XML
    JavaScript Fragment kódu JavaScriptu
    TypeScript Fragment kódu TypeScriptu
    SQL Fragment kódu SQL
    HTML Fragment kódu HTML.

  • Tak trochu. Volitelný atribut, který určuje typ kódu, který fragment kódu obsahuje. Hodnota musí být jedna z následujících hodnot:

    Hodnota Popis
    method body Fragment kódu je tělo metody, a proto musí být vložen do deklarace metody.
    method decl Fragment kódu je metoda, a proto musí být vložen do třídy nebo modulu.
    type decl Fragment kódu je typ, a proto musí být vložen do třídy, modulu nebo oboru názvů.
    file Fragment kódu je soubor s úplným kódem a lze ho vložit do souboru kódu nebo do oboru názvů.
    any Fragment kódu lze vložit kamkoli. Tato značka se používá pro fragmenty kódu, které jsou nezávislé na kontextu, například pro komentáře.

  • Oddělovač. Volitelný atribut, který určuje oddělovač použitý k popisu literálů a objektů v kódu. Ve výchozím nastavení je $oddělovač .

Nadřazený prvek

Nadřazený prvek Popis
Fragment – element Obsahuje odkazy, direktivy import, deklarace a kód fragmentu kódu.

CodeSnippet – element

Umožňuje zadat nadpis a více fragmentů kódu, které můžete vložit do souborů editoru Visual Studio Code.

<CodeSnippet Format="x.x.x">
    <Header>... </Header>
    <Snippet>... </Snippet>
</CodeSnippet>
Atribut Popis
Formát Povinný atribut. Určuje verzi schématu fragmentu kódu. Atribut Format musí být řetězec v syntaxi x.x.x, kde každý x představuje číselnou hodnotu čísla verze. Visual Studio ignoruje fragmenty kódu s atributy Format , kterým nerozumí.
Podřízený prvek Popis
Header – element Povinný prvek. Obsahuje obecné informace o fragmentu kódu. V fragmentu kódu musí být přesně jeden Header prvek.
Fragment – element Povinný prvek. Obsahuje kód, který má visual Studio vložit. V fragmentu kódu musí být přesně jeden Snippet prvek.
Nadřazený prvek Popis
CodeSnippets – element Kořenový element schématu XML fragmentu kódu

CodeSnippets – element

Seskupuje elementy CodeSnippet . Element CodeSnippets je kořenový prvek schématu XML fragmentu kódu.

<CodeSnippets>
    <CodeSnippet>... </CodeSnippet>
</CodeSnippets>
Podřízený prvek Popis
CodeSnippet – element Volitelný element. Nadřazený element pro všechna data fragmentu kódu. Prvek může obsahovat nula nebo více CodeSnippet prvků CodeSnippets .

Element Deklarace

Určuje literály a objekty tvořící části fragmentu kódu, které lze upravovat.

<Declarations>
    <Literal>... </Literal>
    <Object>... </Object>
</Declarations>
Podřízený prvek Popis
Literál – element Volitelný element. Definuje literály fragmentu kódu, které lze upravovat. Prvek může obsahovat nula nebo více Literal prvků Declarations .
Object – element Volitelný element. Definuje objekty fragmentu kódu, které lze upravovat. Prvek může obsahovat nula nebo více Object prvků Declarations .
Nadřazený prvek Popis
Fragment – element Obsahuje odkazy, direktivy import, deklarace a kód fragmentu kódu.

Výchozí prvek

Určuje výchozí hodnotu literálu nebo objektu fragmentu kódu.

<Default>
    Default value
</Default>
Nadřazený prvek Popis
Literál – element Definuje pole literálu fragmentu kódu, která lze upravovat.
Object – element Definuje pole objektu fragment kódu, která lze upravovat.

Je vyžadována textová hodnota. Tento text určuje výchozí hodnotu literálu nebo objektu, pomocí níž budou naplněna pole fragmentu kódu, která lze upravovat.

Element popisu

Určuje popisné informace o obsahu fragmentu kódu.

<Description>
    Code Snippet Description
</Description>
Nadřazený prvek Popis
Header – element Obsahuje obecné informace o fragmentu kódu.

Je vyžadována textová hodnota. Tento text popisuje fragment kódu.

Function – element

Určuje funkci, která se má provést, když literál nebo objekt získá fokus v sadě Visual Studio.

Poznámka:

Ne všechny jazyky podporují Function prvky. Informace o dostupných funkcích najdete v dokumentaci specifické pro jazyk.

<Function>
    FunctionName
</Function>
Nadřazený prvek Popis
Literál – element Definuje pole literálu fragmentu kódu, která lze upravovat.
Object – element Definuje pole objektu fragment kódu, která lze upravovat.

Je vyžadována textová hodnota. Tento text určuje funkci, která se má provést, když pole literálu nebo objektu získá fokus v sadě Visual Studio.

Header – element

Určuje obecné informace o fragmentu kódu.

<Header>
    <Title>... </Title>
    <Author>... </Author>
    <Description>... </Description>
    <HelpUrl>... </HelpUrl>
    <SnippetTypes>... </SnippetTypes>
    <Keywords>... </Keywords>
    <Shortcut>... </Shortcut>
</Header>
Podřízený prvek Popis
Author – element Volitelný element. Jméno osoby nebo společnosti, která fragment kódu vytvořila. Prvek může obsahovat nula nebo jeden Author prvek Header .
Element popisu Volitelný element. Popis fragmentu kódu. Prvek může obsahovat nula nebo jeden Description prvek Header .
Element HelpUrl Volitelný element. Adresa URL s dalšími informacemi o fragmentu kódu. Prvek může obsahovat nula nebo jeden HelpURL prvek Header .
Element Keywords Volitelný element. Seskupuje Keyword prvky. Prvek může obsahovat nula nebo jeden Keywords prvek Header .
Element Shortcut Volitelný element. Určuje textovou zkratku, pomocí níž lze fragment kódu vložit. Prvek může obsahovat nula nebo jeden Shortcut prvek Header .
FragmentTypes – element Volitelný element. Seskupuje SnippetType prvky. Prvek může obsahovat nula nebo jeden SnippetTypes prvek Header . Pokud neexistují žádné SnippetTypes prvky, fragment kódu je vždy platný.
Element Title Povinný prvek. Popisný název fragmentu kódu. V elementu Header musí být přesně jeden Title prvek.
Nadřazený prvek Popis
CodeSnippet – element Nadřazený element pro všechna data fragmentu kódu.

Element HelpUrl

Určujte adresu URL s dalšími informacemi o fragmentu kódu.

Poznámka:

Visual Studio tento prvek nepoužívá HelpUrl . Element je součástí schématu XML fragmentu kódu IntelliSense a fragmenty kódu obsahující prvek ověřují, ale hodnota elementu se nikdy nepoužívá.

<HelpUrl>
    www.microsoft.com
</HelpUrl>
Nadřazený prvek Popis
Header – element Obsahuje obecné informace o fragmentu kódu.

Textová hodnota je volitelná. Tento text určuje adresu URL, na níž naleznete další informace o fragmentu kódu.

Element ID

Určuje jedinečný identifikátor prvku Literal nebo Object prvku. Žádné dva literály nebo objekty ve stejném fragmentu kódu mohou mít ve svých ID prvcích stejnou textovou hodnotu. Literály a objekty nemohou obsahovat ID prvek s hodnotou end. Hodnota $end$ je vyhrazená a slouží k označení umístění, kde se umístí kurzor po vložení fragmentu kódu.

<ID>
    Unique Identifier
</ID>
Nadřazený prvek Popis
Literál – element Definuje pole literálu fragmentu kódu, která lze upravovat.
Object – element Definuje pole objektu fragment kódu, která lze upravovat.

Je vyžadována textová hodnota. Tento text určuje jedinečný identifikátor pro objekt nebo literál.

Import – element

Určuje importované obory názvů používané fragmentem kódu.

<Import>
    <Namespace>... </Namespace>
</Import>
Podřízený prvek Popis
Element oboru názvů Povinný prvek. Určuje obor názvů používaný fragmentem kódu. V elementu Import musí být přesně jeden Namespace prvek.
Nadřazený prvek Popis
Import – element Seskupování elementů Import

Import – element

Seskupí jednotlivé Import prvky.

<Imports>
    <Import>... </Import>
</Imports>
Podřízený prvek Popis
Import – element Volitelný element. Obsahuje naimportované obory názvů pro fragment kódu. Prvek může obsahovat nula nebo více Import prvků Imports .
Nadřazený prvek Popis
Fragment – element Obsahuje odkazy, direktivy import, deklarace a kód fragmentu kódu.

Element klíčového slova

Určuje vlastní klíčové slovo pro fragment kódu. Klíčová slova fragmentů kódu používá sada Visual Studio a představují standardní způsob pro online poskytovatele obsahu, jak přidávat vlastní klíčová slova pro vyhledávání nebo kategorizaci.

<Keyword>
    Code Snippet Keyword
</Keyword>
Nadřazený prvek Popis
Element Keywords Seskupí jednotlivé Keyword prvky.

Je vyžadována textová hodnota. Klíčové slovo fragmentu kódu.

Element Keywords

Seskupí jednotlivé Keyword prvky. Klíčová slova fragmentů kódu používá sada Visual Studio a představují standardní způsob pro online poskytovatele obsahu, jak přidávat vlastní klíčová slova pro vyhledávání nebo kategorizaci.

<Keywords>
    <Keyword>... </Keyword>
    <Keyword>... </Keyword>
</Keywords>
Podřízený prvek Popis
Element klíčového slova Volitelný element. Obsahuje jednotlivá klíčová slova pro fragment kódu. Prvek může obsahovat nula nebo více Keyword prvků Keywords .
Nadřazený prvek Popis
Header – element Obsahuje obecné informace o fragmentu kódu.

Literál – element

Definuje literály fragmentu kódu, které lze upravovat. Element Literal identifikuje náhradu za část kódu zcela obsaženou v fragmentu kódu, který lze přizpůsobit po vložení fragmentu kódu. Jako literály by měly být deklarovány například řetězcové literály, číselné hodnoty a některé názvy proměnných.

Literály a objekty nemohou obsahovat ID prvek s hodnotou selected nebo end. Hodnota $selected$ představuje vybraný text dokumentu, který se má vložit do fragmentu kódu při vyvolání fragmentu. $end$ označí umístění pro umístění kurzoru za vložením fragmentu kódu.

<Literal Editable="true/false">
   <ID>... </ID>
   <ToolTip>... </ToolTip>
   <Default>... </Default>
   <Function>... </Function>
</Literal>
Atribut Popis
Upravitelné Volitelný Boolean atribut. Určuje, zda lze literál po vložení fragmentu kódu upravit. Výchozí hodnota tohoto atributu je true.
Podřízený prvek Popis
Výchozí prvek Povinný prvek. Určuje výchozí hodnotu literálu při vložení fragmentu kódu. V elementu Literal musí být přesně jeden Default prvek.
Function – element Volitelný element. Určuje funkci, která se má provést, když literál získá fokus v sadě Visual Studio. Prvek může obsahovat nula nebo jeden Function prvek Literal .
Element ID Povinný prvek. Určuje jedinečný identifikátor literálu. V elementu Literal musí být přesně jeden ID prvek.
ToolTip – element Volitelný element. Popisuje očekávanou hodnotu a použití literálu. Prvek může obsahovat nula nebo jeden ToolTip prvek Literal .
Nadřazený prvek Popis
Element Deklarace Obsahuje literály a objekty fragmentu kódu, které lze upravovat.

Element oboru názvů

Určuje obor názvů, který musí být naimportován, aby bylo možné fragment kódu zkompilovat a spustit. Obor názvů zadaný v elementu Namespace se automaticky přidá do using direktivy nebo Imports příkazu na začátku kódu, pokud ještě neexistuje.

<Namespace>
    Namespace
</Namespace>
Nadřazený prvek Popis
Import – element Naimportuje zadaný obor názvů.

Je vyžadována textová hodnota. Tento text určuje obor názvů, o kterém fragment kódu předpokládá, že bude naimportován.

Object – element

Definuje objekty fragmentu kódu, které lze upravovat. Element Object identifikuje položku požadovanou fragmentem kódu, který je definován mimo samotný fragment kódu. Jako objekty by měly být deklarovány například ovládací prvky modelu Windows Forms, ovládací prvky technologie ASP.NET nebo instance typů. Deklarace objektů vyžadují, aby byl zadán typ, který se provádí s elementem Type .

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>
Atribut Popis
Upravitelné Volitelný Boolean atribut. Určuje, zda lze literál po vložení fragmentu kódu upravit. Výchozí hodnota tohoto atributu je true.
Podřízený prvek Popis
Výchozí prvek Povinný prvek. Určuje výchozí hodnotu literálu při vložení fragmentu kódu. V elementu Literal musí být přesně jeden Default prvek.
Function – element Volitelný element. Určuje funkci, která se má provést, když literál získá fokus v sadě Visual Studio. Prvek může obsahovat nula nebo jeden Function prvek Literal .
Element ID Povinný prvek. Určuje jedinečný identifikátor literálu. V elementu Literal musí být přesně jeden ID prvek.
ToolTip – element Volitelný element. Popisuje očekávanou hodnotu a použití literálu. Prvek může obsahovat nula nebo jeden ToolTip prvek Literal .
Element Type Povinný prvek. Určuje typ objektu. V elementu Object musí být přesně jeden Type prvek.
Nadřazený prvek Popis
Element Deklarace Obsahuje literály a objekty fragmentu kódu, které lze upravovat.

Referenční prvek

Určuje informace o odkazech na sestavení vyžadovaných fragmentem kódu.

<Reference>
    <Assembly>... </Assembly>
    <Url>... </Url>
</Reference>
Podřízený prvek Popis
Assembly – element Povinný prvek. Obsahuje název sestavení, na které se odkazuje fragment kódu. V elementu Reference musí být přesně jeden Assembly prvek.
Url – element Volitelný element. Obsahuje adresu URL s dalšími informacemi o odkazovaném sestavení. Prvek může obsahovat nula nebo jeden Url prvek Reference .
Nadřazený prvek Popis
Reference – element Seskupování elementů Reference

Reference – element

Seskupí jednotlivé Reference prvky.

<References>
    <Reference>... </Reference>
</References>
Podřízený prvek Popis
Referenční prvek Volitelný element. Obsahuje informace o odkazech na sestavení pro fragment kódu. Prvek může obsahovat nula nebo více Reference prvků References .
Nadřazený prvek Popis
Fragment – element Obsahuje odkazy, direktivy import, deklarace a kód fragmentu kódu.

Element Shortcut

Určuje textovou zkratku, pomocí níž lze fragment kódu vložit. Textová Shortcut hodnota prvku může obsahovat pouze alfanumerické znaky a podtržítka (_).

Poznámka:

Zkratky fragmentu kódu jazyka C++ nepodporují znak podtržítka (_).

<Shortcut>
    Shortcut Text
</Shortcut>
Nadřazený prvek Popis
Header – element Obsahuje obecné informace o fragmentu kódu.

Textová hodnota je volitelná. Tento text slouží jako zkratka pro vkládání fragmentů kódu.

Fragment – element

Určuje odkazy, direktivy import, deklarace a kód fragmentu kódu.

<Snippet>
    <References>... </References>
    <Imports>... </Imports>
    <Declarations>... </Declarations>
    <Code>... </Code>
</Snippet>
Podřízený prvek Popis
Element kódu Povinný prvek. Určuje kód, který chcete vložit do souboru dokumentace. V elementu Snippet musí být přesně jeden Code prvek.
Element Deklarace Volitelný element. Určuje literály a objekty tvořící části fragmentu kódu, které lze upravovat. Prvek může obsahovat nula nebo jeden Declarations prvek Snippet .
Import – element Volitelný element. Seskupí jednotlivé Import prvky. Prvek může obsahovat nula nebo jeden Imports prvek Snippet .
Reference – element Volitelný element. Seskupí jednotlivé Reference prvky. Prvek může obsahovat nula nebo jeden References prvek Snippet .
Nadřazený prvek Popis
CodeSnippet – element Umožňuje zadat nadpis a více fragmentů kódu, které můžete vložit do souborů editoru Visual Studio Code.

FragmentType – element

Určuje, jak Visual Studio přidá fragment kódu.

<SnippetType>
    SurroundsWith/Expansion
</SnippetType>
Nadřazený prvek Popis
FragmentTypes – element Seskupuje SnippetType prvky.

Hodnota musí být jedna z následujících hodnot:

Hodnota Popis
Expansion Umožňuje vložení fragmentu kódu na kurzor.
Refactoring Určuje, že se fragment kódu používá během refaktoringu jazyka C#. Refactoring nelze použít ve vlastních fragmentech kódu.
SurroundsWith Umožňuje umístit fragment kódu kolem vybrané části kódu.

FragmentTypes – element

Seskupí jednotlivé SnippetType prvky. SnippetTypes Pokud prvek není k dispozici, můžete fragment kódu vložit na kurzor nebo umístit kolem vybraného kódu.

<SnippetTypes>
    <SnippetType>... </SnippetType>
    <SnippetType>... </SnippetType>
</SnippetTypes>
Podřízený prvek Popis
FragmentType – element Volitelný element. Určuje, jak sada Visual Studio vloží fragment kódu do kódu. Prvek může obsahovat nula nebo více SnippetType prvků SnippetTypes .
Nadřazený prvek Popis
Header – element Určuje obecné informace o fragmentu kódu.

Element Title

Určuje název fragmentu kódu. Název uložený v Title prvku fragmentu kódu se zobrazí v nástroji pro výběr fragmentu kódu a jako název fragmentu kódu ve Správci fragmentů kódu.

<Title>
    Code Snippet Title
</Title>
Nadřazený prvek Popis
Header – element Určuje obecné informace o fragmentu kódu.

Je vyžadována textová hodnota. Tento text určuje název fragmentu kódu.

ToolTip – element

Popisuje očekávanou hodnotu a použití literálu nebo objektu ve fragmentu kódu. Visual Studio tyto informace zobrazí v popisu při vložení fragmentu kódu do projektu. Popis se také zobrazí, když po vložení fragmentu kódu najede myší na literál nebo objekt.

<ToolTip>
    ToolTip description
</ToolTip>
Nadřazený prvek Popis
Literál – element Definuje pole literálu fragmentu kódu, která lze upravovat.
Object – element Definuje pole objektu fragment kódu, která lze upravovat.

Je vyžadována textová hodnota. Tento text určuje popisek přidružený k objektu nebo literálu ve fragmentu kódu.

Element Type

Určuje typ objektu. Element Object identifikuje položku, kterou fragment kódu vyžaduje, ale pravděpodobně je definován mimo samotný fragment kódu. Jako objekty by měly být deklarovány například ovládací prvky modelu Windows Forms, ovládací prvky technologie ASP.NET nebo instance typů. Deklarace objektů vyžadují, aby byl zadán typ, který se provádí s elementem Type .

<Type>
    Type
</Type>
Nadřazený prvek Popis
Object – element Definuje pole objektu fragment kódu, která lze upravovat.

Je vyžadována textová hodnota. Tento text určuje typ objektu. Příklad:

<Type>System.Data.SqlClient.SqlConnection</Type>

Url – element

Určuje adresu URL s dalšími informacemi o odkazovaném sestavení.

Poznámka:

Tento Url prvek je podporován pouze pro projekty jazyka Visual Basic.

<Url>
    www.microsoft.com
</Url>
Nadřazený prvek Popis
Referenční prvek Určuje odkazy na sestavení vyžadované fragmentem kódu.

Je vyžadována textová hodnota. Tento text určuje adresu URL s dalšími informacemi o odkazovaném sestavení. Tato adresa URL se zobrazí, když se odkaz nedá přidat do projektu.

Související obsah