HelpUrl Element (IntelliSense Code Snippets)

Article
02/23/2011

Specifies a URL that provides more information about a code snippet.

<HelpUrl>
    www.microsoft.com
</HelpUrl>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child Elements

None.

Parent Elements

Element	Description
Header	Contains general information about a code snippet.

Text Value

A text value is optional.

This text specifies the URL to visit for more information about a code snippet.

Remarks

Visual Studio 2005 does not use the HelpUrl element. 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.

Example

The HelpUrl element in the following code snippet has the value www.microsoft.com. This URL appears as a comment at the beginning of the code snippet.

<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>

Share via