Header 要素 (IntelliSense コード スニペット)

更新 : 2007 年 11 月

IntelliSense コード スニペットに関する全般的な情報を指定します。

<Header>
    <Title>... </Title>
    <Author>... </Author>
    <Description>... </Description>
    <HelpUrl>... </HelpUrl>
    <SnippetTypes>... </SnippetTypes>
    <Keywords>... </Keywords>
    <Shortcut>... </Shortcut>
</Header>

属性と要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

なし。

子要素

要素	説明
Author	省略可能な要素 コード スニペットを作成した個人または会社の名前です。Header 要素に 0 個または 1 個の Author 要素があります。
Description	省略可能な要素 コード スニペットの説明です。Header 要素に 0 個または 1 個の Description 要素があります。
HelpURL	省略可能な要素 コード スニペットに関する詳細な情報が記載された URL です。Header 要素に 0 個または 1 個の HelpURL 要素があります。
Keywords	省略可能な要素 複数の Keyword 要素をグループ化します。Header 要素に 0 個または 1 個の Keywords 要素があります。
Shortcut	省略可能な要素 スニペットの挿入に使用するショートカット テキストを指定します。Header 要素に 0 個または 1 個の Shortcut 要素があります。
SnippetTypes	省略可能な要素 複数の SnippetType 要素をグループ化します。Header 要素に 0 個または 1 個の SnippetTypes 要素があります。SnippetTypes 要素が存在しない場合、コード スニペットは常に有効となります。
Title	必須の要素 コード スニペットの表示名です。Header 要素で使用できる Title 要素は 1 つだけです。

親要素

要素	説明
CodeSnippet	すべてのコード スニペット データを下位に持つ親要素です。

使用例

Header 要素の子要素に値を設定する方法を次のコードに示します。

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Copy File</Title>
            <Author>Microsoft Corporation</Author>
            <Description>Copies a file and saves it as another file.</Description>
            <HelpUrl>www.microsoft.com</HelpUrl>
            <SnippetTypes>
                <SnippetType>Expansion</SnippetType>
            </SnippetTypes>
            <Keywords>
                 <Keyword>File copying</Keyword>
                 <Keyword>Copying files</Keyword>
            </Keywords>
            <Shortcut>copyfile</Shortcut>
        </Header>
        <Snippet>
            <!-- Insert snippet information here -->
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

参照

概念

コード スニペット スキーマ リファレンス