共用方式為

Header 項目 (IntelliSense 程式碼片段)

  • 發行項

指定有關 IntelliSense 程式碼片段的一般資訊。

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

屬性和項目

下列各節將說明屬性、子項目和父項目。

屬性

無。

子項目

項目

說明

Author

選擇性項目。

設計程式碼片段的人員或公司名稱。 Header 項目中可能有零個或一個 Author 項目。

Description

選擇性項目。

程式碼片段的描述。 Header 項目中可能有零個或一個 Description 項目。

HelpURL

選擇性項目。

包含有關該程式碼片段詳細資訊的 URL。 Header 項目中可能有零個或一個 HelpURL 項目。

關鍵字

選擇性項目。

群組 Keyword 項目。 Header 項目中可能有零個或一個 Keywords 項目。

捷徑

選擇性項目。

指定可用來插入程式碼片段的捷徑文字。 Header 項目中可能有零個或一個 Shortcut 項目。

SnippetTypes

選擇性項目。

群組 SnippetType 項目。 Header 項目中可能有零個或一個 SnippetTypes 項目。 如果沒有 SnippetTypes 項目，該程式碼片段永遠都是有效的。

標題

必要項目。

程式碼片段的易記名稱。 Header 項目中必定正好有一個 Title 項目。

父項目

項目

描述

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>

請參閱

概念

程式碼片段結構描述參考