Erstellen von Vorlagen mit mehreren Projekten

Artikel
05/02/2024

Vorlagen mit mehreren Projekten fungieren als Container für mindestens zwei Visual Studio-Projekte. Wenn Sie ein Projekt erstellen, das auf einer Vorlage mit mehreren Projekten basiert, wird jedes Projekt in der Vorlage zur Projektmappe hinzugefügt.

Hinweis

Die in diesem Artikel behandelten Vorlagen sind die beim Erstellen von Projekten in Visual Studio verwendeten, nicht die mit dotnet new erstellten Vorlagen.

Eine Vorlage mit mehreren Projekten verfügt über mindestens zwei Projektvorlagen und eine Stammvorlage des Typs ProjectGroup.

Vorlagen mit mehreren Projekten verhalten sich anders als Vorlagen mit einem Projekt. Sie weisen folgende eindeutige Merkmale auf:

Einzelnen Projekten in einer Vorlage mit mehreren Projekten können keine Namen zugewiesen werden, wenn die Vorlage zum Erstellen eines neuen Projekts verwendet wird. Verwenden Sie stattdessen das Attribut ProjectName des Elements ProjectTemplateLink in der VSTEMPLATE-Datei, um einen Namen für jedes Projekt anzugeben.
Vorlagen mit mehreren Projekten können Projekte für unterschiedliche Sprachen enthalten. Die gesamte Vorlage kann jedoch nur einer einzigen Kategorie zugeordnet werden. Geben Sie die Kategorie der Vorlage im ProjectType-Element der VSTEMPLATE-Datei an.

Eine Vorlage mit mehreren Projekten muss folgende in eine ZIP-Datei komprimierte Elemente enthalten:

Eine VSTEMPLATE-Stammdatei für die gesamte Vorlage mit mehreren Projekten. Diese Datei vstemplate im Stammverzeichnis enthält Metadaten, die im Dialogfeld angezeigt werden, in dem Sie ein neues Projekt erstellen. Sie gibt außerdem an, wo sich die vstemplate-Dateien für die in der Vorlage enthaltenen Projekte befinden. Die Datei muss sich im Stamm der ZIP-Datei befinden.
Für eine vollständige Projektvorlage sind mindestens zwei Ordner erforderlich, die die Dateien enthalten. Diese Ordner enthalten alle Codedateien und eine VSTEMPLATE-Datei für das Projekt.

Eine ZIP-Datei für eine Vorlage mit mehreren Projekten, die zwei Projekte enthält, kann beispielsweise folgende Dateien und Verzeichnisse enthalten:

MultiProjectTemplate.vstemplate
\Project1\MyTemplate.vstemplate
\Project1\Project1.vbproj
\Project1\Class.vb
\Project2\MyTemplate.vstemplate
\Project2\Project2.vbproj
\Project2\Class.vb

Die VSTEMPLATE-Stammdatei für eine Vorlage mit mehreren Projekten unterscheidet sich folgendermaßen von der für eine Vorlage mit einem einzelnen Projekt:

Das Type-Attribut des VSTemplate-Elements hat den Wert ProjectGroup statt Project. Zum Beispiel:

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">

Das TemplateContent-Element enthält ein ProjectCollection-Element, das über mindestens ein ProjectTemplateLink-Element verfügt, das den Pfad der VSTEMPLATE-Datei der enthaltenen Projekte definiert. Zum Beispiel:

<TemplateContent>
    <ProjectCollection>
        <ProjectTemplateLink>
            Project1\MyTemplate.vstemplate
        </ProjectTemplateLink>
        <ProjectTemplateLink>
            Project2\MyTemplate.vstemplate
        </ProjectTemplateLink>
    </ProjectCollection>
</TemplateContent>

Tipp

Wenn Sie möchten, dass nur die Vorlage mit mehreren Projekten im Dialogfenster des neuen Projekts angezeigt wird und nicht die darin enthaltenen Einzelprojekte, markieren Sie die inneren Vorlagen als ausgeblendet. Zum Beispiel:

<VSTemplate Type="Project" ... >
    <TemplateData>
        ...
        <Hidden>true</Hidden>
    </TemplateData>
    ...
</VSTemplate>

Erstellen einer Vorlage mit mehreren Projekten aus einer vorhandenen Projektmappe

Erstellen Sie eine Projektmappe, und fügen Sie mindestens zwei Projekte hinzu.
Passen Sie die Projekte an, bis diese in eine Vorlage exportiert werden können.
Tipp

Wenn Sie Vorlagenparameter verwenden und auf die Variablen der übergeordneten Vorlage verweisen möchten, fügen Sie das Präfix ext_ zum Namen des Parameters hinzu. Beispielsweise $ext_safeprojectname$ . Setzen Sie auch das Attribut CopyParameters des Elements ProjectTemplateLink auf true.
```
<ProjectTemplateLink ProjectName="MyProject" CopyParameters="true">...</ProjectTemplateLink>
```
Klicken Sie im Menü Projekt auf Vorlage exportieren.

Der Assistent zum Exportieren von Vorlagen wird geöffnet.
Wählen Sie auf der Seite Vorlagentyp auswählen die Option Projektvorlage aus. Wählen Sie eines der Projekte aus, die Sie in eine Vorlage exportieren möchten, und klicken Sie anschließend auf Weiter. (Sie müssen diese Schritte für jedes Projekt in der Projektmappe wiederholen.)
Geben Sie auf der Seite Vorlagenoptionen auswählen einen Namen, ggf. eine Beschreibung sowie ein Symbol für Ihre Vorlage ein, und fügen Sie ein Vorschaubild hinzu. Klicken Sie auf Fertig stellen.

Das Projekt wird als ZIP-Datei exportiert und am angegebenen Speicherort platziert.

Hinweis

Jedes Projekt muss separat als Vorlage exportiert werden. Wiederholen Sie die vorherigen Schritte also für jedes Projekt in der Projektmappe.
Erstellen Sie ein Verzeichnis für Ihre Vorlage und ein Unterverzeichnis für jedes Projekt.
Extrahieren Sie die Inhalte für die ZIP-Datei jedes Projekts in das entsprechende Unterverzeichnis, das Sie erstellt haben.
Erstellen Sie im Basisverzeichnis eine XML-Datei mit der Erweiterung VSTEMPLATE. Diese Datei enthält die Metadaten für die Vorlage mit mehreren Projekten. Im Folgenden finden Sie ein Beispiel für die Struktur der Datei. Stellen Sie sicher, dass Sie den relativen Pfad zu der VSTEMPLATE-Datei eines jeden Projekts angeben.
Wählen Sie alle Dateien im Basisverzeichnis aus, rufen Sie das Kontextmenü aus, und wählen Sie Senden an>ZIP-komprimierter Ordner aus.

Die Dateien und Ordner werden in eine ZIP-Datei komprimiert.
Kopieren Sie die ZIP-Datei in das Verzeichnis für Benutzerprojektvorlagen. Standardmäßig ist das Verzeichnis %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ProjectTemplates.
Wählen Sie in Visual Studio Datei>Neu>Projekt aus, und überprüfen Sie, ob Ihre Vorlage angezeigt wird.

Beispiel mit zwei Projekten

Dieses Beispiel zeigt eine einfache VSTEMPLATE-Stammdatei für mehrere Projekte. In diesem Beispiel enthält die Vorlage zwei Projekte: My Windows Application und My Class Library. Das ProjectName-Attribut des ProjectTemplateLink-Elements gibt den Namen an, der dem Projekt zugewiesen ist.

Tipp

Wenn das ProjectName-Attribut nicht angegeben ist, wird der Name der VSTEMPLATE-Datei als Projektname verwendet.

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>Multi-Project Template Sample</Name>
        <Description>An example of a multi-project template</Description>
        <Icon>Icon.ico</Icon>
        <ProjectType>VisualBasic</ProjectType>
    </TemplateData>
    <TemplateContent>
        <ProjectCollection>
            <ProjectTemplateLink ProjectName="My Windows Application">
                WindowsApp\MyTemplate.vstemplate
            </ProjectTemplateLink>
            <ProjectTemplateLink ProjectName="My Class Library">
                ClassLib\MyTemplate.vstemplate
            </ProjectTemplateLink>
        </ProjectCollection>
    </TemplateContent>
</VSTemplate>

Beispiel mit Projektmappenordnern

In diesem Beispiel wird das SolutionFolder-Element verwendet, um die Projekte in zwei Gruppen zu unterteilen: Math Classes und Graphics Classes. Die Vorlage enthält vier Projekte, von denen sich je zwei in jedem Projektmappenordner befinden.

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>Multi-Project Template Sample</Name>
        <Description>An example of a multi-project template</Description>
        <Icon>Icon.ico</Icon>
        <ProjectType>VisualBasic</ProjectType>
    </TemplateData>
    <TemplateContent>
        <ProjectCollection>
            <SolutionFolder Name="Math Classes">
                <ProjectTemplateLink ProjectName="MathClassLib1">
                    MathClassLib1\MyTemplate.vstemplate
                </ProjectTemplateLink>
                <ProjectTemplateLink ProjectName="MathClassLib2">
                    MathClassLib2\MyTemplate.vstemplate
                </ProjectTemplateLink>
            </SolutionFolder>
            <SolutionFolder Name="Graphics Classes">
                <ProjectTemplateLink ProjectName="GraphicsClassLib1">
                    GraphicsClassLib1\MyTemplate.vstemplate
                </ProjectTemplateLink>
                <ProjectTemplateLink ProjectName="GraphicsClassLib2">
                    GraphicsClassLib2\MyTemplate.vstemplate
                </ProjectTemplateLink>
            </SolutionFolder>
        </ProjectCollection>
    </TemplateContent>
</VSTemplate>

Beispiel mit Projektverweisen

In diesem Beispiel wird gezeigt, wie Projektverweise zu einer Projektvorlage mit mehreren Projekten hinzugefügt werden. Es handelt sich im Prinzip um eine Erweiterung des Beispiels für die Vorlage mit mehreren Projekten .

In diesem Beispiel enthält die Lösung zwei Projekte: MultiProject.Client und MultiProject.Shared. Das Projekt MultiProject.Client verweist auf MultiProject.Shared.

Die Ordnerstruktur lautet wie folgt:

MultiProjectTemplate.vstemplate
\MultiProject.Client\MultiProject.Client.csproj
\MultiProject.Client\MyTemplate.vstemplate
\MultiProject.Shared\MultiProject.Shared.csproj
\MultiProject.Shared\MyTemplate.vstemplate

Wenn die Vorlage verwendet wird, wird der MultiProject-Teil durch den Projektnamen ersetzt, den der Benutzer eingibt.

MultiProjectTemplate.vstemplate sieht wie folgt aus. Beachten Sie, dass für projectTemplateLinks das Attribut CopyParameters auf true festgelegt ist und dass die ProjectName-Attribute die Vorlagenvariable $safeprojectname$ verwenden.

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
...
<TemplateContent>
    <ProjectCollection>
        <ProjectTemplateLink ProjectName="$safeprojectname$.Client" CopyParameters="true">
            MultiProject.Client\MyTemplate.vstemplate
        </ProjectTemplateLink>
        <ProjectTemplateLink ProjectName="$safeprojectname$.Shared" CopyParameters="true">
            MultiProject.Shared\MyTemplate.vstemplate
        </ProjectTemplateLink>
    </ProjectCollection>
</TemplateContent>
</VSTemplate>

MultiProject.Client\MyTemplate.vstemplate könnte etwa wie folgt aussehen. Beachten Sie, dass durch das Project-Tag das Attribut ReplaceParameters auf true festgelegt ist.

<VSTemplate Version="3.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Project">
	...
	<TemplateContent>
		<Project TargetFileName="MultiProject.Client.csproj" File="MultiProject.Client.csproj" ReplaceParameters="true">
            ...
		</Project>
	</TemplateContent>
</VSTemplate>

MultiProject.Client\MultiProject.Client.csproj könnte etwa wie folgt aussehen. Beachten Sie, dass das Attribut Include der ProjectReference die Vorlagenvariable $ext_safeprojectname$ verwendet.

<Project>
    ...
	<ItemGroup>
	  <ProjectReference Include="..\$ext_safeprojectname$.Shared\$ext_safeprojectname$.Shared.csproj" />
	</ItemGroup>
</Project>

Freigeben über

Erstellen von Vorlagen mit mehreren Projekten

Erstellen einer Vorlage mit mehreren Projekten aus einer vorhandenen Projektmappe

Beispiel mit zwei Projekten

Beispiel mit Projektmappenordnern

Beispiel mit Projektverweisen

Feedback

Feedback

Zusätzliche Ressourcen

Freigeben über

Erstellen von Vorlagen mit mehreren Projekten

Erstellen einer Vorlage mit mehreren Projekten aus einer vorhandenen Projektmappe

Beispiel mit zwei Projekten

Beispiel mit Projektmappenordnern

Beispiel mit Projektverweisen

Zugehöriger Inhalt

Feedback

Feedback

Zusätzliche Ressourcen