Erstellen von benutzerdefinierten Projekt- und Elementvorlagen

  • Artikel

Das Visual Studio SDK enthält Projektvorlagen, aus denen eine benutzerdefinierte Projektvorlage und eine benutzerdefinierte Elementvorlage erstellt werden können. Diese Vorlagen enthalten häufige Parameterersetzungen und sind als ZIP-Dateien gepackt. Sie werden nicht automatisch bereitgestellt, und sie sind in der experimentellen Instanz nicht verfügbar. Sie müssen die generierte ZIP-Datei in das Verzeichnis für Benutzervorlagen kopieren.

Mit den Vorlagen zur Vorlagenerstellung können Sie Vorlagen in größere Erweiterungen einschließen. So können Sie die Versionskontrolle in Quelldateien implementieren und Vorlagenprojekte in einem VSIX-Paket erstellen.

Sie können auch eine Vorlage für die Installation von NuGet-Paketen konfigurieren. Weitere Informationen finden Sie unter NuGet-Pakete in Visual Studio-Vorlagen.

Bei der Erstellung einfacher Vorlagen sollten Sie den Assistenten Vorlage exportieren verwenden, der eine komprimierte Datei generiert. Weitere Informationen zur Erstellung einfacher Vorlagen finden Sie unter Erstellen von Projekt- und Elementvorlagen.

Hinweis

Ab Visual Studio 2017 wird die Überprüfung auf benutzerdefinierte Projekt- und Elementvorlagen nicht mehr ausgeführt. Die Erweiterung muss nun Vorlagenmanifestdateien mit dem Installationspfad dieser Vorlagen enthalten. Sie können Visual Studio verwenden, um Ihre VSIX-Erweiterungen zu aktualisieren. Wenn Sie eine Erweiterung über eine MSI-Datei bereitstellen, müssen Sie die Vorlagenmanifestdateien manuell generieren. Weitere Informationen finden Sie unter Aktualisieren von benutzerdefinierten Projekt- und Elementvorlagen für Visual Studio 2017. Das Vorlagenmanifestschema ist in der Referenz zum Visual Studio-Vorlagenmanifestschema dokumentiert.

Eine Projektvorlage erstellen

  1. Erstellen Sie ein Projektvorlagenprojekt. Sie finden die Projektvorlage im Dialogfeld Neues Projekt, wenn Sie nach „Projektvorlage“ suchen und dann die Version für C# oder Visual Basic auswählen.

    Die Vorlage generiert eine Klassendatei, ein Symbol, eine .vstemplate Datei, eine bearbeitbare Projektdatei mit dem Namen "ProjectTemplate.vbproj " oder "ProjectTemplate.csproj" und einige Dateien, die normalerweise von anderen Projekttypen generiert werden, z. B. einer Datei "resources.resx ", einer AssemblyInfo-Datei und einer .settings Datei. Jede Codedatei enthält die benötigten gängigen Parameterersetzungen.

    Screenshot of project template project selection.

  2. Fügen Sie nach Bedarf Elemente zum Projekt hinzu, oder löschen Sie Elemente aus dem Projekt. Entfernen Sie nicht die bearbeitbare Projektdatei, die AssemblyInfo-Datei oder die .vstemplate Datei.

  3. Aktualisieren Sie die .vstemplate Datei so, dass alle Ergänzungen und Löschungen berücksichtigt werden. Das Project-Element muss ein ProjectItem-Element für jede Datei enthalten, die der Vorlage hinzugefügt wird.

  4. Bearbeiten Sie Codedateien und andere Inhalte für Benutzer, und fügen Sie die entsprechenden Parameterersetzungen hinzu.

  5. Bearbeiten Sie den generierten Inhalt nach Bedarf.

  6. Erstellen Sie das Projekt.

    Visual Studio erstellt eine .zip Datei, die Ihre Vorlage enthält. Sie wird nicht bereitgestellt und ist in der experimentellen Instanz nicht verfügbar.

Erstellen einer Elementvorlage

  1. Erstellen Sie ein Elementvorlagenprojekt.

    Die Vorlage generiert eine Klassendatei, ein Symbol, eine .vstemplate Datei und eine AssemblyInfo-Datei . Die Klassendatei enthält einige gängige Parameterersetzungen.

  2. Fügen Sie nach Bedarf Elemente zum Projekt hinzu, oder löschen Sie Elemente aus dem Projekt.

  3. Aktualisieren Sie die .vstemplate Datei so, dass alle Ergänzungen und Löschungen berücksichtigt werden. Das Project-Element muss ein ProjectItem-Element für jede Datei enthalten, die der Vorlage hinzugefügt wird.

  4. Bearbeiten Sie Codedateien und andere Inhalte für Benutzer, und fügen Sie die entsprechenden Parameterersetzungen hinzu.

  5. Bearbeiten Sie den generierten Inhalt nach Bedarf.

  6. Erstellen Sie das Projekt.

    Visual Studio erstellt eine komprimierte Datei, die Ihre Vorlage enthält. Sie wird nicht bereitgestellt und ist in der experimentellen Instanz nicht verfügbar.

Bereitstellung

Bereitstellen der Projekt- oder Elementvorlage

  1. Erstellen eines VSIX-Projekts Weitere Informationen finden Sie unter VSIX-Projektvorlage.

  2. Legen Sie das VSIX-Projekt als Startprojekt fest. Klicken Sie im Projektmappen-Explorer auf den VSIX-Projektknoten, klicken Sie mit der rechten Maustaste, und wählen Sie Als Startprojekt festlegen aus.

  3. Legen Sie das Projektvorlagenprojekt als Objekt des VSIX-Projekts fest. Öffnen Sie die VSIXMANIFEST-Datei. Wechseln Sie zur Registerkarte Objekte, und klicken Sie auf Neu.

    1. Legen Sie das Feld Typ auf Microsoft.VisualStudio.ProjectTemplate oder Microsoft.VisualStudio.ItemTemplate fest.

    2. Wählen Sie für die Quelle die Option Ein Projekt in der aktuellen Projektmappe und dann das Projekt aus, das Ihre Vorlage enthält.

  4. Drücken Sie F5, um die Projektmappe zu kompilieren. Die experimentelle Instanz wird geöffnet.

  5. Bei einem Projektvorlagenprojekt sollte die Projektvorlage im Dialogfeld Neues Projekt (Datei>Neu>Projekt) unter Visual C# oder Visual Basic aufgeführt werden. Bei einem Elementvorlagenprojekt sollte die Elementvorlage im Dialogfeld Neues Element hinzufügen aufgeführt werden. Sie können das Dialogfeld Neues Element hinzufügen aufrufen, indem Sie im Projektmappen-Explorer auf den Projektknoten und dann auf Hinzufügen>Neues Element klicken.

Siehe auch