Gewusst wie: Veröffentlichen von Codeausschnitten

Artikel
09/02/2008

Aktualisiert: November 2007

Damit ein Codeausschnitt im Code-Editor auf dem Computer eines Benutzers angezeigt wird, muss er auf dem Computer installiert sein und mit dem Codeausschnitt-Manager in Visual Studio importiert werden. Zur Vereinfachung dieses Vorgangs können Sie die Ausschnittdatei in eine VSI (Visual Studio Installer)-Datei setzen, die ein Benutzer mit dem Visual Studio-Inhaltsinstaller am richtigen Speicherort ablegen kann. Die VSI-Datei kann dann problemlos mit anderen Entwicklern gemeinsam genutzt werden.

VSI-Dateien

.Mit VSI-Dateien werden Visual Studio-Inhalte innerhalb der Entwicklercommunity ausgetauscht. Eine VSI-Datei ist eine normale ZIP-Datei, die jedoch mit einer VSI-Dateinamenerweiterung umbenannt werden muss, damit sie vom Visual Studio-Inhaltsinstaller verarbeitet werden kann. .VSI-Dateien enthalten die folgenden Elemente:

In einer VSCONTENT-Datei wird mit XML-Code, der einem bestimmten XML-Schema folgt, der Inhalt der VSI-Datei beschrieben. Eine vollständige Definition des Schemas für VSCONTENT-Dateien finden Sie unter Gewusst wie: Verpacken von Communitykomponenten, die den Visual Studio-Inhaltsinstaller verwenden.
Inhaltsdateien, z. B. eine SNIPPET-Datei. Informationen zur Vorgehensweise beim Erstellen von SNIPPET-Dateien finden Sie unter Gewusst wie: Erstellen eines grundlegenden Codeausschnitts.

Der Visual Studio-Inhaltsinstaller verwendet VSI-Dateien, um gemeinsam genutzten Inhalt im richtigen Verzeichnis zu installieren. Weitere Informationen zum Installieren von VSI-Dateien finden Sie unter Gewusst wie: Installieren von Communitykomponenten.

In der VSCONTENT-Datei müssen Sie bestimmte Werte und Attribute festlegen, damit der Visual Studio-Inhaltsinstaller die Inhaltsdateien auf die richtige Weise und am richtigen Speicherort installiert. Beispielsweise müssen Sie in der VSCONTENT-Datei bei einem Codeausschnitt wie folgt vorgehen:

Festlegen des FileContentType-Elementwerts auf Code Snippet.
Fügen Sie ein Attribute-Element mit dem folgenden Attribut hinzu:
- lang: Gibt die Sprache des Codeausschnitts an, entweder csharp, jsharp, vb oder xml.

So erstellen Sie eine Codeausschnittdatei (VSI-Datei)

Erstellen Sie eine gültige VSCONTENT-Datei für den Inhalt. Weitere Informationen zum VSCONTENT-Dateischema finden Sie unter Gewusst wie: Verpacken von Communitykomponenten, die den Visual Studio-Inhaltsinstaller verwenden.
Markieren Sie die in die VSI-Datei aufzunehmenden Dateien (einschließlich der VSCONTENT-Datei), klicken Sie mit der rechten Maustaste auf die Auswahl, wählen Sie Senden an aus, und klicken Sie auf ZIP-komprimierter Ordner. Die ausgewählten Dateien werden in eine einzelne ZIP-Datei komprimiert.

Ändern Sie die Dateinamenerweiterung der ZIP-Datei in .vsi.

Hinweis:
Wenn im Visual Studio-Inhaltsinstaller Herausgeberinformationen über Ihren Codeabschnitt angezeigt werden sollen, müssen Sie die VSI-Datei signieren. Weitere Informationen erhalten Sie bei einem Anbieter von digitalen Zertifikaten.

Beispiel

Im folgenden Beispiel wird eine VSCONTENT-Datei für eine VSI-Datei veranschaulicht, die einen Codeausschnitt enthält. Im Beispiel wird ein ContentVersion-Wert von 2.0 verwendet. Wenn ein Codeausschnitt sowohl von Visual Studio als auch von Visual Studio 2008 verwendet werden kann, wählen Sie den Wert 1.0. Bei einem Codeausschnitt nur für Visual Studio 2008 verwenden Sie 2.0. Die folgenden Dateien wären in dieser VSI-Datei enthalten:

Eine VSCONTENT-Datei mit dem Code aus diesem Beispiel.
Der Codeausschnitt MyCodeSnippet.snippet.

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005">
    <Content>
        <FileName>MyCodeSnippet.snippet</FileName>
        <DisplayName>Sample Code Snippet</DisplayName>
        <Description>A code snippet created for this example</Description>
        <FileContentType>Code Snippet</FileContentType>
        <ContentVersion>2.0</ContentVersion>
        <Attributes>
            <Attribute name="lang" value="vb"/>
        </Attributes>
    </Content>
</VSContent>

Siehe auch

Aufgaben

Gewusst wie: Verpacken von Communitykomponenten, die den Visual Studio-Inhaltsinstaller verwenden

Referenz

Erstellen und Verwenden von IntelliSense-Codeausschnitten

Freigeben über