コード スニペット スキーマ リファレンスCode Snippets Schema Reference

IntelliSense コード スニペットとは、Visual StudioVisual Studio でのアプリケーション開発時に、簡単に挿入できるようにあらかじめ作成されたコードです。IntelliSense Code Snippets are pre-authored pieces of code that are ready to be inserted into your application with Visual StudioVisual Studio. 同じようなコードを繰り返し入力したり、サンプルを検索したりする時間を短縮するコード スニペットを用意しておくことで、生産性を高めることができます。You can increase productivity by providing code snippets that reduce the amount of time spent typing repetitive code or searching for samples. IntelliSense コード スニペット XML スキーマを使用すると、独自のコード スニペットを作成し、それらを Visual StudioVisual Studio に標準で付属しているコード スニペットに追加できます。You can use the IntelliSense Code Snippet XML schema to create your own code snippets and add them to the code snippets that Visual StudioVisual Studio already includes.

IntelliSense コード スニペット スキーマ要素IntelliSense Code Snippets Schema Elements

Assembly 要素Assembly Element HelpUrl 要素HelpUrl Element References 要素References Element
Author 要素Author Element ID 要素ID Element Shortcut 要素Shortcut Element
Code 要素Code Element Import 要素Import Element Snippet 要素Snippet Element
CodeSnippet 要素CodeSnippet Element Imports 要素Imports Element SnippetType 要素SnippetType Element
CodeSnippets 要素CodeSnippets Element Keyword 要素Keyword Element SnippetTypes 要素SnippetTypes Element
Declarations 要素Declarations Element Keywords 要素Keywords Element Title 要素Title Element
Default 要素Default Element Literal 要素Literal Element ToolTip 要素ToolTip Element
Description 要素Description Element 名前空間要素Namespace Element Type 要素Type Element
Function 要素Function Element Object 要素Object Element Url 要素Url Element
Header 要素Header Element Reference 要素Reference Element

Assembly 要素Assembly Element

コード スニペットによって参照されるアセンプリの名前を指定します。Specifies the name of the assembly referenced by the code snippet.

Assembly 要素のテキスト値は、アセンブリの表示名 (System.dll など) で指定することも、厳密な名前 (System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1 など) で指定することもできます。The text value of the Assembly element is either the friendly text name of the assembly, such as System.dll, or its strong name, such as System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.

<Assembly>  
    AssemblyName  
</Assembly>  
Parent 要素Parent Element 説明Description
Reference 要素Reference Element コード スニペットで参照する必要のあるアセンブリについての情報が格納されます。Contains information about assembly references required by the code snippet.

テキスト値が必要です。A text value is required. このテキストで、コード スニペットが参照するアセンブリを指定します。This text specifies the assembly that the code snippet references.

Author 要素Author Element

スニペット作成者の名前を指定します。Specifies the name of the snippet author. コード スニペット マネージャーには、コード スニペットの Author 要素に格納された名前が表示されます。The Code Snippets Manager displays the name stored in the Author element of the code snippet.

<Author>  
   Code Snippet Author  
</Author>    
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報が格納されます。Contains general information about the code snippet.

テキスト値が必要です。A text value is required. このテキストでコード スニペットの作成者を指定します。This text specifies the author of the code snippet.

Code 要素 Code Element

短いコード ブロックのコンテナーを提供します。Provides a container for short code blocks.

キーワードKeywords

Code 要素のテキストでは、$end$ および $selected$ という 2 つの予約語を使用できます。Two reserved words are available for use in the text of the Code element: $end$ and $selected$. $end$ は、コード スニペットの挿入後のカーソル位置を指定します。$end$ marks the location to place the cursor after the code snippet is inserted. $selected$ は、ドキュメントで選択されているテキストを表し、スニペットが呼び出されたときに置き換えられます。$selected$ represents text selected in the document that is to be inserted into the snippet when it is invoked. たとえば、次のコードを含むスニペットがあるとします。For example, given a snippet that includes:

$selected$ is a great color.  

ユーザーがテンプレートを呼び出したときに、単語 "Blue" を選択した場合、結果は次のようになります。If the word "Blue" is selected when the user invokes the template, the result is:

Blue is a great color.  

$end$$selected$ は、どちらもコード スニペット内で複数回使用することはできません。You may not use either $end$ or $selected$ more than once in a code snippet. 複数回使用した場合、2 つ目のインスタンスだけが認識されます。If you do, only the second instance is recognized. 次のコードを含むスニペットがあるとします。Given a snippet that includes:

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

単語 "Blue" を選択した場合、結果は次のようになります。If the word "Blue" is selected, the result is:

 is a great color. I love Blue.  

$selected$is の間にスペースがあるため、先頭にスペースが表示されます。The initial space appears because there is a space between $selected$ and is.

その他の $ キーワードはすべて、<Literal> タグおよび <Object> タグで動的に定義されます。All other $ keywords are dynamically defined in the <Literal> and <Object> tags.

Code 要素の構造を以下に示します。Following is the structure of the Code element:

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

テキスト値が必要です。A text value is required. このテキストで、コード スニペットをコード ファイルに挿入した場合に使用できるコードを、リテラルおよびオブジェクトと共に指定します。This text specifies the code, along with the literals and objects, that you can use when this code snippet is inserted into a code file.

属性Attributes

Code 要素に使用できる属性には次の 3 つがあります。There are three attributes available for the Code element:

  • Language - 必須 の属性。コード スニペットの言語を指定します。Language - Required attribute that specifies the language of the code snippet. 値は次のいずれかになります。The value can be one of the following:

    Value 説明Description
    VB Visual Studio のコード スニペットであることを示します。Identifies a Visual Basic code snippet.
    CSharp C# のコード スニペットであることを示します。Identifies a C# code snippet.
    CPP C++ のコード スニペットであることを示します。Identifies a C++ code snippet.
    XML XML のコード スニペットであることを示します。Identifies an XML code snippet.
    JavaScript JavaScript のコード スニペットであることを示します。Identifies a JavaScript code snippet.
    SQL SQL のコード スニペットであることを示します。Identifies a SQL code snippet.
    HTML HTML のコード スニペットであることを示します。Identifies an HTML code snippet.
  • Kind - 省略可能 な属性。コード スニペットをコンパイルするために、スニペットに含まれているコードの種類と、そのコード スニペットを挿入すべき場所を指定します。Kind - Optional attribute that specifies the kind of code that the snippet contains, and the location at which a code snippet must be inserted for the code snippet to compile. 値は次のいずれかになります。The value can be one of the following:

    Value 説明Description
    method body コード スニペットがメソッドの本体であり、メソッド宣言の内部に挿入する必要があることを示します。Specifies that the code snippet is a method body, and therefore, must be inserted inside a method declaration.
    method decl コード スニペットがメソッドであり、クラスまたはモジュールの内部に挿入する必要があることを示します。Specifies that the code snippet is a method, and therefore, must be inserted inside a class or module.
    type decl コード スニペットが型であり、クラス、モジュール、または名前空間の内部に挿入する必要があることを示します。Specifies that the code snippet is a type, and therefore, must be inserted inside a class, module, or namespace.
    file スニペットが完全なコード ファイルであることを示します。Specifies that the snippet is a full code file. これらのコード スニペットは、単体でコード ファイルに挿入することも、名前空間内に挿入することもできます。These code snippets can be inserted alone into a code file, or inside a namespace.
    any スニペットをどこにでも挿入できることを示します。Specifies that the snippet can be inserted anywhere. このタグは、コメントなど、コンテキストに依存しないコード スニペットに使用します。This tag is used for code snippets that are context-independent, such as comments.
  • Delimiter - 省略可能 な属性。コード内のリテラルおよびオブジェクトを説明するために使用される区切り文字を指定します。Delimiter - Optional attribute that specifies the delimiter used to describe literals and objects in the code. 既定では、区切り記号は $ です。By default, the delimiter is $.

親要素Parent element

Parent 要素Parent Element 説明Description
Snippet 要素Snippet Element コード スニペットの参照、インポート、宣言、およびコードが格納されます。Contains the references, imports, declarations, and code for the code snippet.

CodeSnippet 要素CodeSnippet Element

Visual Studio Code ファイルに挿入できる見出しと複数の IntelliSense コード スニペットを指定します。Allows you to specify a heading and multiple IntelliSense Code Snippets, which you can insert into Visual Studio code files.

<CodeSnippet Format="x.x.x">  
    <Header>... </Header>  
    <Snippet>... </Snippet>  
</CodeSnippet>  
属性Attribute 説明Description
Format 必須の属性です。Required attribute. コード スニペットのスキーマ バージョンを指定します。Specifies the schema version of the code snippet. Format 属性は、x.x.x (x はそれぞれバージョン番号の数値) の構文の文字列で指定されなければなりません。The Format attribute must be a string in the syntax of x.x.x, where each "x" represents a numerical value of the version number. Visual Studio では、理解できない Format 属性を含むコード スニペットを無視します。Visual Studio will ignore code snippets with Format attributes that it does not understand.
子要素Child Element 説明Description
Header 要素Header Element 必須の要素です。Required element. コード スニペットに関する全般的な情報が格納されます。Contains general information about the code snippet. コード スニペットで使用できる Header 要素は 1 つだけです。There must be exactly one Header element in a code snippet.
Snippet 要素Snippet Element 必須の要素です。Required element. Visual Studio によって挿入されるコードが格納されます。Contains the code that will be inserted by Visual Studio. コード スニペットで使用できる Snippet 要素は 1 つだけです。There must be exactly one Snippet element in a code snippet.
Parent 要素Parent Element 説明Description
CodeSnippets 要素CodeSnippets Element コード スニペットの XML スキーマのルート要素です。Root element of the code snippet XML schema.

CodeSnippets 要素CodeSnippets Element

複数の CodeSnippet 要素をグループ化します。Groups CodeSnippet Elementelements. CodeSnippets 要素は、コード スニペットの XML スキーマにおけるルート要素です。The CodeSnippets element is the root element of the code snippet XML schema.

<CodeSnippets>  
    <CodeSnippet>... </CodeSnippet>  
</CodeSnippets>  
子要素Child Element 説明Description
CodeSnippet 要素CodeSnippet Element 省略可能な要素です。Optional element. すべてのコード スニペット データを下位に持つ親要素です。Parent element for all code snippet data. CodeSnippet 要素に 0 個以上の CodeSnippets 要素があります。There may be zero or more CodeSnippet elements in a CodeSnippets element.

Declarations 要素Declarations Element

編集できるコード スニペットの部分を構成するリテラルとオブジェクトを指定します。Specifies the literals and objects that make up the parts of a code snippet that you can edit.

<Declarations>  
    <Literal>... </Literal>  
    <Object>... </Object>  
</Declarations>  
子要素Child Element 説明Description
Literal 要素Literal Element 省略可能な要素です。Optional element. 編集できるコード スニペットのリテラルを定義します。Defines the literals of the code snippet that you can edit. Literal 要素に 0 個以上の Declarations 要素があります。There may be zero or more Literal elements in a Declarations element.
Object 要素Object Element 省略可能な要素です。Optional element. 編集できるコード スニペットのオブジェクトを定義します。Defines the objects of the code snippet that you can edit. Object 要素に 0 個以上の Declarations 要素があります。There may be zero or more Object elements in a Declarations element.
Parent 要素Parent Element 説明Description
Snippet 要素Snippet Element コード スニペットの参照、インポート、宣言、およびコードが格納されます。Contains the references, imports, declarations, and code for the code snippet.

Default 要素Default Element

IntelliSense コード スニペットのリテラルまたはオブジェクトの既定値を指定します。Specifies the default value of the literal or object for an IntelliSense Code Snippet.

<Default>  
    Default value  
</Default>  
Parent 要素Parent Element 説明Description
Literal 要素Literal Element 編集が可能なコード スニペットのリテラル フィールドを定義します。Defines the literal fields of the code snippet that you can edit.
Object 要素Object Element 編集が可能なコード スニペットのオブジェクト フィールドを定義します。Defines the object fields of the code snippet that you can edit.

テキスト値が必要です。A text value is required. このテキストは、編集できるコード スニペットのフィールドに入れるリテラルまたはオブジェクトの既定値を指定します。This text specifies the default value of the literal or object that fills the fields of the code snippet that you can edit.

Description 要素Description Element

IntelliSense コード スニペットの内容に関する説明文を指定します。Specifies descriptive information about the contents of an IntelliSense Code Snippet.

<Description>  
    Code Snippet Description  
</Description>  
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報が格納されます。Contains general information about the code snippet.

テキスト値が必要です。A text value is required. このテキストで、コード スニペットについて説明します。This text describes the code snippet.

Function 要素Function Element

Visual Studio でリテラルまたはオブジェクトがフォーカスを取得するときに実行される関数を指定します。Specifies a function to execute when the literal or object receives focus in Visual Studio.

注意

Function 要素は、Visual C# のコード スニペットでのみサポートされます。The Function element is only supported in Visual C# code snippets.

<Function>  
    FunctionName  
</Function>  
Parent 要素Parent Element 説明Description
Literal 要素Literal Element 編集が可能なコード スニペットのリテラル フィールドを定義します。Defines the literal fields of the code snippet that you can edit.
Object 要素Object Element 編集が可能なコード スニペットのオブジェクト フィールドを定義します。Defines the object fields of the code snippet that you can edit.

テキスト値が必要です。A text value is required. このテキストで、Visual Studio でリテラルまたはオブジェクト フィールドがフォーカスを取得するときに実行される関数を指定します。This text specifies a function to execute when the literal or object field receives focus in Visual Studio.

IntelliSense コード スニペットの一般情報を指定します。Specifies general information about the IntelliSense Code Snippet.

<Header>  
    <Title>... </Title>  
    <Author>... </Author>  
    <Description>... </Description>  
    <HelpUrl>... </HelpUrl>  
    <SnippetTypes>... </SnippetTypes>  
    <Keywords>... </Keywords>  
    <Shortcut>... </Shortcut>  
</Header>  
子要素Child Element 説明Description
Author 要素Author Element 省略可能な要素です。Optional element. コード スニペットを作成した個人または会社の名前です。The name of the person or company that authored the code snippet. Author 要素には 0 個または 1 個の Header 要素があります。There may be zero or one Author elements in a Header element.
Description 要素Description Element 省略可能な要素です。Optional element. コード スニペットの説明です。A description of the code snippet. Description 要素には 0 個または 1 個の Header 要素があります。There may be zero or one Description elements in a Header element.
HelpUrl 要素HelpUrl Element 省略可能な要素です。Optional element. コード スニペットに関する詳細な情報が記載された URL です。A URL that contains more information about the code snippet. Header 要素には 0 個または 1 個の HelpURL 要素があります。There may be zero or one HelpURL elements in a Header element. 注: Visual Studio では HelpUrl 要素を使いません。Note: Visual Studio does not use the HelpUrl element. この要素は IntelliSense コード スニペット XML スキーマの一部であり、この要素を含むコード スニペットはすべて問題なく検証されますが、要素の値が使われることはありません。The element is part of the IntelliSense Code Snippet XML schema and any code snippet containing the element will validate, but the value of the element is never used.
Keywords 要素Keywords Element 省略可能な要素です。Optional element. 複数の Keyword 要素をグループ化します。Groups Keyword elements. Keywords 要素には 0 個または 1 個の Header 要素があります。There may be zero or one Keywords elements in a Header element.
Shortcut 要素Shortcut Element 省略可能な要素です。Optional element. スニペットの挿入に使用するショートカット テキストを指定します。Specifies the shortcut text that can be used to insert the snippet. Shortcut 要素には 0 個または 1 個の Header 要素があります。There may be zero or one Shortcut elements in a Header element.
SnippetTypes 要素SnippetTypes Element 省略可能な要素です。Optional element. 複数の SnippetType 要素をグループ化します。Groups SnippetType elements. SnippetTypes 要素には 0 個または 1 個の Header 要素があります。There may be zero or one SnippetTypes elements in a Header element. SnippetTypes 要素が存在しない場合、コード スニペットは常に有効となります。If there are no SnippetTypes elements, the code snippet is always valid.
Title 要素Title Element 必須の要素です。Required element. コード スニペットの表示名です。The friendly name of the code snippet. Title 要素で使用できる Header 要素は 1 つだけです。There must be exactly one Title element in a Header element.
Parent 要素Parent Element 説明Description
CodeSnippet 要素CodeSnippet Element すべてのコード スニペット データを下位に持つ親要素です。Parent element for all code snippet data.

HelpUrl 要素HelpUrl Element

コード スニペットに関する詳細な情報の入手先 URL を指定します。Specifies a URL that provides more information about a code snippet.

注意

Visual Studio では HelpUrl 要素を使用しません。Visual Studio does not use the HelpUrl element. この要素は IntelliSense コード スニペット XML スキーマの一部であり、この要素を含むコード スニペットはすべて問題なく検証されますが、要素の値が使われることはありません。The element is part of the IntelliSense Code Snippet XML schema and any code snippet containing the element will validate, but the value of the element is never used.

<HelpUrl>  
    www.microsoft.com  
</HelpUrl>  
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報が格納されます。Contains general information about the code snippet.

テキスト値は省略可能です。A text value is optional. このテキストで、コード スニペットに関する詳細情報の入手先 URL を指定します。This text specifies the URL to visit for more information about a code snippet.

ID 要素ID Element

Literal 要素または Object 要素の一意の識別子を指定します。Specifies a unique identifier for a Literal or Object element. 同じコード スニペット内で、2 つのリテラルまたはオブジェクトの ID 要素に同じテキスト値を割り当てることはできません。リテラルおよびオブジェクトに、end という値の ID 要素を使用することはできません。No two literals or objects in the same code snippet can have the same text value in their ID elements.Literals and objects cannot contain an ID element with a value of end. $end$ という値は、コード スニペットの挿入後のカーソル位置をマーキングする目的で予約されています。The value $end$ is reserved, and is used to mark the location to place the cursor after the code snippet is inserted.

<ID>  
    Unique Identifier  
</ID>  
Parent 要素Parent Element 説明Description
Literal 要素Literal Element 編集が可能なコード スニペットのリテラル フィールドを定義します。Defines the literal fields of the code snippet that you can edit.
Object 要素Object Element 編集が可能なコード スニペットのオブジェクト フィールドを定義します。Defines the object fields of the code snippet that you can edit.

テキスト値が必要です。A text value is required. このテキストで、オブジェクトまたはリテラルの一意の識別子を指定します。This text specifies the unique identifier for the object or literal.

Import 要素Import Element

IntelliSense コード スニペットによって使用されるインポートされた名前空間を指定します。Specifies the imported namespaces used by an IntelliSense Code Snippet.

注意

Import 要素は、Visual Basic プロジェクトでのみサポートされます。The Import element is only supported for Visual Basic projects.

<Import>  
    <Namespace>... </Namespace>  
</Import>  
子要素Child Element 説明Description
名前空間要素Namespace Element 必須の要素です。Required element. コード スニペットで使用される名前空間を指定します。Specifies the namespace used by the code snippet. Namespace 要素で使用できる Import 要素は 1 つだけです。There must be exactly one Namespace element in an Import element.
Parent 要素Parent Element 説明Description
Imports 要素Imports Element Import 要素のグループ化要素です。Grouping element for Import elements.

Imports 要素Imports Element

複数の Import 要素をグループ化します。Groups individual Import elements.

注意

Imports 要素は、Visual Basic プロジェクトでのみサポートされます。The Imports element is only supported for Visual Basic projects.

<Imports>  
    <Import>... </Import>  
<Imports>  
子要素Child Element 説明Description
Import 要素Import Element 省略可能な要素です。Optional element. コード スニペットでインポートする必要のある名前空間が格納されます。Contains the imported namespaces for the code snippet. Imports 要素には 0 個以上の Import 要素があります。There may be zero or more Import elements in an Imports element.
Parent 要素Parent Element 説明Description
Snippet 要素Snippet Element コード スニペットの参照、インポート、宣言、およびコードが格納されます。Contains the references, imports, declarations, and code for the code snippet.

Keyword 要素Keyword Element

コード スニペットのカスタム キーワードを指定します。Specifies a custom keyword for the code snippet. コード スニペットのキーワードは Visual Studio によって使用され、検索や分類のためのカスタム キーワードを追加する手段をオンライン コンテンツ プロバイダーに提供します。The code snippet keywords are used by Visual Studio and represent a standard way for online content providers to add custom keywords for searching or categorization.

<Keyword>  
    Code Snippet Keyword  
</Keyword>  
Parent 要素Parent Element 説明Description
Keywords 要素Keywords Element 複数の Keyword 要素をグループ化します。Groups individual Keyword elements.

テキスト値が必要です。A text value is required. コード スニペットのキーワードを指定します。The keyword for the code snippet.

Keywords 要素Keywords Element

複数の Keyword 要素をグループ化します。Groups individual Keyword elements. コード スニペットのキーワードは Visual Studio によって使用され、検索や分類のためのカスタム キーワードを追加する手段をオンライン コンテンツ プロバイダーに提供します。The code snippet keywords are used by Visual Studio and represent a standard way for online content providers to add custom keywords for searching or categorization

<Keywords>  
    <Keyword>... </Keyword>  
    <Keyword>... </Keyword>  
<Keywords>  
子要素Child Element 説明Description
Keyword 要素Keyword Element 省略可能な要素です。Optional element. コード スニペットの複数のキーワードが格納されます。Contains individual keywords for the code snippet. Keyword 要素に 0 個以上の Keywords 要素があります。There may be zero or more Keyword elements in a Keywords element.
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報が格納されます。Contains general information about the code snippet.

Literal 要素Literal Element

編集できるコード スニペットのリテラルを定義します。Defines the literals of the code snippet that you can edit. Literal 要素は、コード スニペットの中で置き換えて使用できる部分を識別する目的で使用されます。The Literal element is used to identify a replacement for a piece of code that is entirely contained within the snippet, but will likely be customized after it is inserted into the code. たとえば、リテラル文字列、数値、および変数名はリテラルとして宣言されなければなりません。For example, literal strings, numeric values, and some variable names should be declared as literals.

リテラルおよびオブジェクトに、selected または end という値の ID 要素を含めることはできません。Literals and objects cannot contain an ID element with a value of selected or end. $selected$ は、ドキュメントで選択されているテキストを表し、スニペットが呼び出されたときに置き換えられます。The value $selected$ represents text selected in the document that is to be inserted into the snippet when it is invoked. $end$ は、コード スニペットの挿入後のカーソル位置を指定します。$end$ marks the location to place the cursor after the code snippet is inserted.

<Literal Editable="true/false">  
   <ID>... </ID>  
   <ToolTip>... </ToolTip>  
   <Default>... </Default>  
   <Function>... </Function>  
</Literal>  
属性Attribute 説明Description
Editable 省略可能な Boolean 属性です。Optional Boolean attribute. コード スニペットが挿入された後にリテラルを編集可能にするかどうかを指定します。Specifies whether or not you can edit the literal after the code snippet is inserted. この属性の既定値は true です。The default value of this attribute is true.
子要素Child Element 説明Description
Default 要素Default Element 必須の要素です。Required element. コード スニペットを挿入した場合に、既定で使用されるリテラルの値を指定します。Specifies the literal's default value when you insert the code snippet. Default 要素で使用できる Literal 要素は 1 つだけです。There must be exactly one Default element in a Literal element.
Function 要素Function Element 省略可能な要素です。Optional element. リテラルが Visual Studio でフォーカスを受け取ったときに実行される関数を指定します。Specifies a function to execute when the literal receives focus in Visual Studio. Function 要素には 0 個または 1 個の Literal 要素があります。There may be zero or one Function elements in a Literal element.
ID 要素ID Element 必須の要素です。Required element. リテラルの一意の識別子を指定します。Specifies a unique identifier for the literal. ID 要素で使用できる Literal 要素は 1 つだけです。There must be exactly one ID element in a Literal element.
ToolTip 要素ToolTip Element 省略可能な要素です。Optional element. リテラルに予想される値と使用法に関する説明文です。Describes the expected value and usage of the literal. Literal 要素には 0 個または 1 個の Tooltip 要素があります。There may be zero or one Tooltip elements in a Literal element.
Parent 要素Parent Element 説明Description
Declarations 要素Declarations Element 編集が可能なコード スニペットのリテラルおよびオブジェクトを保持します。Contains the literals and objects of a code snippet that you can edit.

名前空間要素Namespace Element

コード スニペットをコンパイルおよび実行するためにインポートする必要のある名前空間を指定します。Specifies the namespace that must be imported for the code snippet to compile and run. Namespace 要素で指定された名前空間が存在しない場合、コードの先頭に Imports ステートメントとして自動的に追加されます。The namespace specified in the Namespace element is automatically added to an Imports statement at the beginning of the code, if it does not already exist.

注意

Namespace 要素は、Visual Basic プロジェクトでのみサポートされます。The Namespace element is only supported for Visual Basic projects.

<Namespace>  
    Namespace  
</Namespace>  
Parent 要素Parent Element 説明Description
Import 要素Import Element 指定された名前空間をインポートします。Imports the specified namespace.

テキスト値が必要です。A text value is required. このテキストで、コード スニペットを使用するためにインポートする必要のある名前空間を指定します。This text specifies a namespace that the code snippet assumes is imported.

Object 要素Object Element

編集できるコード スニペットのオブジェクトを定義します。Defines the objects of the code snippet that you can edit. Object 要素は、コード スニペット自体には定義されておらず、外部で定義する必要のある項目を指定するときに使用します。The Object element is used to identify an item that is required by the code snippet but is likely to be defined outside of the snippet itself. たとえば、Windows フォーム コントロール、ASP.NET コントロール、オブジェクトのインスタンス、型のインスタンスなどをオブジェクトとして宣言します。For example, Windows Forms controls, ASP.NET controls, object instances, and type instances should be declared as objects. オブジェクトの宣言では、Type 要素で型を指定する必要があります。Object declarations require that a type be specified, which is done with the Type element.

<Object Editable="true/false">  
    <ID>... </ID>  
    <Type>... </Type>  
    <ToolTip>... </ToolTip>  
    <Default>... </Default>  
    <Function>... </Function>  
</Object>  
属性Attribute 説明Description
Editable 省略可能な Boolean 属性です。Optional Boolean attribute. コード スニペットが挿入された後にリテラルを編集可能にするかどうかを指定します。Specifies whether or not you can edit the literal after the code snippet is inserted. この属性の既定値は true です。The default value of this attribute is true.
子要素Child Element 説明Description
Default 要素Default Element 必須の要素です。Required element. コード スニペットを挿入した場合に、既定で使用されるリテラルの値を指定します。Specifies the literal's default value when you insert the code snippet. Default 要素で使用できる Literal 要素は 1 つだけです。There must be exactly one Default element in a Literal element.
Function 要素Function Element 省略可能な要素です。Optional element. リテラルが Visual Studio でフォーカスを受け取ったときに実行される関数を指定します。Specifies a function to execute when the literal receives focus in Visual Studio. Function 要素には 0 個または 1 個の Literal 要素があります。There may be zero or one Function elements in a Literal element.
ID 要素ID Element 必須の要素です。Required element. リテラルの一意の識別子を指定します。Specifies a unique identifier for the literal. ID 要素で使用できる Literal 要素は 1 つだけです。There must be exactly one ID element in a Literal element.
ToolTip 要素ToolTip Element 省略可能な要素です。Optional element. リテラルに予想される値と使用法に関する説明文です。Describes the expected value and usage of the literal. Literal 要素には 0 個または 1 個の Tooltip 要素があります。There may be zero or one Tooltip elements in a Literal element.
Type 要素Type Element 必須の要素です。Required element. オブジェクトの種類を指定します。Specifies the type of the object. Type 要素で使用できる Object 要素は 1 つだけです。There must be exactly one Type element in an Object element.
Parent 要素Parent Element 説明Description
Declarations 要素Declarations Element 編集が可能なコード スニペットのリテラルおよびオブジェクトを保持します。Contains the literals and objects of a code snippet that you can edit.

Reference 要素Reference Element

コード スニペットで参照する必要のあるアセンブリについての情報を指定します。Specifies information about the assembly references required by the code snippet.

<Reference>  
    <Assembly>... </Assembly>  
    <Url>... </Url>  
</Reference>  
子要素Child Element 説明Description
Assembly 要素Assembly Element 必須の要素です。Required element. コード スニペットによって参照されるアセンプリの名前が格納されます。Contains the name of the assembly referenced by the code snippet. Assembly 要素で使用できる Reference 要素は 1 つだけです。There must be exactly one Assembly element in a Reference element.
Url 要素Url Element 省略可能な要素です。Optional element. 参照アセンブリに関する詳細な情報の入手先 URL が格納されます。Contains a URL that provides more information about the referenced assembly. Url 要素には 0 個または 1 個の Reference 要素があります。There may be zero or one Url elements in a Reference element.
Parent 要素Parent Element 説明Description
References 要素References Element Reference 要素のグループ化要素です。Grouping element for Reference elements.

References 要素References Element

複数の Reference 要素をグループ化します。Groups individual Reference elements.

<References>  
    <Reference>... </Reference>  
</References>  
子要素Child Element 説明Description
Reference 要素Reference Element 省略可能な要素です。Optional element. コード スニペットで参照する必要のあるアセンブリについての情報が格納されます。Contains information about assembly references for the code snippet. Reference 要素に 0 個以上の References 要素があります。There may be zero or more Reference elements in a References element.
Parent 要素Parent Element 説明Description
Snippet 要素Snippet Element コード スニペットの参照、インポート、宣言、およびコードが格納されます。Contains the references, imports, declarations, and code for the code snippet.

Shortcut 要素Shortcut Element

スニペットの挿入に使用するショートカット テキストを指定します。Specifies the shortcut text used to insert the snippet. Shortcut 要素のテキスト値には、英数字、ハイフン (-)、およびアンダースコア () のみを含めることができます。The text value of a Shortcut element can only contain alphanumeric characters, hyphens ( - ), and underscores ( ).

注意事項

と - の文字は C++ スニペットのショートカットではサポートされていません。 and - are not supported characters in C++ snippet shortcuts.

<Shortcut>  
    Shortcut Text  
</Shortcut>  
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報が格納されます。Contains general information about the code snippet.

テキスト値は省略可能です。A text value is optional. このテキストは、コード スニペットを挿入するためのショートカットとして使用されます。This text is used as a shortcut for inserting the code snippet.

Snippet 要素Snippet Element

参照、インポート、宣言およびコード スニペット用のコードを指定します。Specifies the references, imports, declarations, and code for the code snippet.

<Snippet>  
    <References>... </References>  
    <Imports>... </Imports>  
    <Declarations>... </Declarations>  
    <Code>... </Code>  
</Snippet>    
子要素Child Element 説明Description
Code 要素Code Element 必須の要素です。Required element. ドキュメント ファイルに挿入するコードを指定します。Specifies the code that you want to insert into a documentation file. Code 要素で使用できる Snippet 要素は 1 つだけです。There must be exactly one Code element in a Snippet element.
Declarations 要素Declarations Element 省略可能な要素です。Optional element. 編集できるコード スニペットの部分を構成するリテラルとオブジェクトを指定します。Specifies the literals and objects that make up the parts of a code snippet that you can edit. Declarations 要素には 0 個または 1 個の Snippet 要素があります。There may be zero or one Declarations elements in a Snippet element.
Imports 要素Imports Element 省略可能な要素です。Optional element. 複数の Import 要素をグループ化します。Groups individual Import elements. Imports 要素には 0 個または 1 個の Snippet 要素があります。There may be zero or one Imports elements in a Snippet element.
省略可能な要素です。Optional element. 複数の Reference 要素をグループ化します。Groups individual Reference elements. References 要素には 0 個または 1 個の Snippet 要素があります。There may be zero or one References elements in a Snippet element.
Parent 要素Parent Element 説明Description
CodeSnippet 要素CodeSnippet Element Visual Studio Code ファイルに挿入できる見出しと複数の IntelliSense コード スニペットを指定します。Allows you to specify a heading and multiple IntelliSense Code Snippets, which you can insert into Visual Studio code files.

SnippetType 要素SnippetType Element

Visual Studio がコード スニペットをどのように挿入するかを指定します。Specifies how Visual Studio inserts the code snippet.

<SnippetType>  
    SurroundsWith/Expansion  
<SnippetType>  
Parent 要素Parent Element 説明Description
SnippetTypes 要素SnippetTypes Element 複数の SnippetType 要素をグループ化します。Groups SnippetType elements.

テキスト値は、次のいずれかの値である必要があります。The text value must be one of the following values:

  • SurroundsWith: 選択したコードの周りにコード スニペットを配置します。SurroundsWith: allows the code snippet to be placed around a selected piece of code.

  • Expansion : カーソル位置にコード スニペットを挿入します。Expansion: allows the code snippet to be inserted at the cursor.

  • Refactoring: Visual C# のリファクタリング中にコード スニペットを使用するよう指定します。Refactoring: specifies that the code snippet is used during Visual C# refactoring. Refactoring は、カスタムのコード スニペットには使用できません。Refactoring cannot be used in custom code snippets.

SnippetTypes 要素SnippetTypes Element

複数の SnippetType 要素をグループ化します。Groups individual SnippetType elements. SnippetTypes 要素が存在しない場合、コード スニペットはコード内のどこにでも挿入できます。If the SnippetTypes element is not present, the code snippet can be inserted anywhere in the code.

<SnippetTypes>  
    <SnippetType>... </SnippetType>  
    <SnippetType>... </SnippetType>  
<SnippetTypes>  
子要素Child Element 説明Description
SnippetType 要素SnippetType Element 省略可能な要素です。Optional element. Visual Studio がコード スニペットをコードに挿入するときの動作を指定します。Specifies how Visual Studio inserts the code snippet into the code. SnippetType 要素に 0 個以上の SnippetTypes 要素があります。There may be zero or more SnippetType elements in a SnippetTypes element.
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報を指定します。Specifies general information about the code snippet.

Title 要素Title Element

コード スニペットのタイトルを指定します。Specifies the title for the code snippet. コード スニペットの Title 要素に格納されたタイトルは、コード スニペット ピッカーと、コード スニペット マネージャー内のコード スニペットの説明に表示されます。The title stored in the Title element of the code snippet appears in the Code Snippet Picker and in the code snippet's description in the Code Snippets Manager.

<Title>  
    Code Snippet Title  
<Title>  
Parent 要素Parent Element 説明Description
Header 要素Header Element コード スニペットに関する全般的な情報を指定します。Specifies general information about the code snippet.

テキスト値が必要です。A text value is required. このテキストでコード スニペットのタイトルを指定します。This text specifies the title of the code snippet.

ToolTip 要素ToolTip Element

コード スニペット内のリテラルまたはオブジェクトに指定される値と使用方法を説明します。これは、プロジェクトにコード スニペットを挿入するときに Visual Studio によって ToolTip に表示されます。Describes the expected value and usage of a literal or object in a code snippet, which Visual Studio displays in a ToolTip when it inserts the code snippet into a project. コード スニペットの挿入後、リテラルまたはオブジェクト上にマウスを重ねると、ツールヒントのテキストが表示されます。The ToolTip text is displayed when the mouse hovers over the literal or object after the code snippet has been inserted.

<ToolTip>  
    ToolTip description  
</ToolTip>  
Parent 要素Parent Element 説明Description
Literal 要素Literal Element 編集が可能なコード スニペットのリテラル フィールドを定義します。Defines the literal fields of the code snippet that you can edit.
Object 要素Object Element 編集が可能なコード スニペットのオブジェクト フィールドを定義します。Defines the object fields of the code snippet that you can edit.

テキスト値が必要です。A text value is required. このテキストは、コード スニペットのオブジェクトまたはリテラルに関連付けられる ToolTip の説明を指定します。This text specifies the ToolTip description to be associated with the object or literal in the code snippet.

Type 要素Type Element

オブジェクトの種類を指定します。Specifies the type of the object. Object 要素は、コード スニペット自体には定義されておらず、外部で定義する必要のある項目を指定するときに使用します。The Object element is used to identify an item that is required by the code snippet but is likely to be defined outside of the snippet itself. たとえば、Windows フォーム コントロール、ASP.NET コントロール、オブジェクトのインスタンス、型のインスタンスなどをオブジェクトとして宣言します。For example, Windows Forms controls, ASP.NET controls, object instances, and type instances should be declared as objects. オブジェクトの宣言では、Type 要素で型を指定する必要があります。Object declarations require that a type be specified, which is done with the Type element.

<Type>  
    Type  
</Type>  
Parent 要素Parent Element 説明Description
Object 要素Object Element 編集が可能なコード スニペットのオブジェクト フィールドを定義します。Defines the object fields of the code snippet that you can edit.

テキスト値が必要です。A text value is required. このテキストでオブジェクトの型を指定します。This text specifies the type of the object.

Url 要素Url Element

参照アセンブリの詳細情報を提供する URL を指定します。Specifies a URL that provides more information about the referenced assembly.

注意

Url 要素は、Visual Basic プロジェクトでのみサポートされます。The Url element is only supported for Visual Basic projects.

<Url>  
    www.microsoft.com  
</Url>  
Parent 要素Parent Element 説明Description
Reference 要素Reference Element コード スニペットで参照する必要のあるアセンブリを指定します。Specifies the assembly references required by the code snippet.

テキスト値が必要です。A text value is required. このテキストで、参照アセンブリに関する詳細な情報の入手先 URL を指定します。This text specifies a URL with more information about the referenced assembly. プロジェクトに参照を追加できない場合、この URL が表示されます。This URL is displayed when the reference cannot be added to the project.

関連項目See Also

コード スニペット Code Snippets
チュートリアル: コード スニペットを作成するWalkthrough: Creating a Code Snippet