Tworzenie niestandardowych szablonów projektów i elementów

Zestaw SDK programu Visual Studio zawiera szablony projektów, które tworzą niestandardowy szablon projektu i szablon elementu niestandardowego. Te szablony obejmują niektóre typowe podstawianie parametrów i kompilowanie jako pliki zip. Nie są one wdrażane automatycznie i nie są dostępne w wystąpieniu eksperymentalnym. Należy skopiować wygenerowany plik zip do katalogu szablonu użytkownika.

Szablony tworzenia szablonu umożliwiają dołączanie szablonów do większych rozszerzeń. Dzięki temu można zaimplementować kontrolę wersji w plikach źródłowych i utworzyć grupę projektów szablonów w jednym pakiecie VSIX.

Można również skonfigurować szablon do instalowania pakietów NuGet. Aby uzyskać więcej informacji, zobacz Pakiety NuGet w szablonach programu Visual Studio.

W przypadku podstawowych scenariuszy tworzenia szablonów należy użyć Kreatora eksportu szablonu , który zwraca dane wyjściowe do skompresowanego pliku. Aby uzyskać więcej informacji na temat tworzenia podstawowego szablonu, zobacz Tworzenie szablonów projektów i elementów.

Uwaga

Począwszy od programu Visual Studio 2017 skanowanie pod kątem niestandardowych szablonów projektów i elementów nie jest już wykonywane. Zamiast tego rozszerzenie musi podać pliki manifestu szablonu opisujące lokalizację instalacji tych szablonów. Za pomocą programu Visual Studio można zaktualizować rozszerzenia VSIX. W przypadku wdrażania rozszerzenia przy użyciu tożsamości usługi zarządzanej należy ręcznie wygenerować pliki manifestu szablonu. Aby uzyskać więcej informacji, zobacz Uaktualnianie niestandardowych szablonów projektów i elementów dla programu Visual Studio 2017. Schemat manifestu szablonu jest udokumentowany w dokumentacji schematu manifestu szablonu programu Visual Studio.

Tworzenie szablonu projektu

1. Utwórz projekt szablonu projektu. Szablon projektu można znaleźć w oknie dialogowym Nowy projekt , wyszukując frazę "szablon projektu" i wybierając wersję języka C# lub Visual Basic.

   Szablon generuje plik klasy, ikonę.vstemplate, plik, edytowalny plik projektu o nazwie ProjectTemplate.vbproj lub ProjectTemplate.csproj oraz niektóre pliki, które są zwykle generowane przez inne typy projektów, takie jak plik resources.resx, plik AssemblyInfo i .settings plik. Każdy plik kodu zawiera wspólne podstawianie parametrów, jeśli jest to konieczne.

   

2. Dodaj i usuń elementy z projektu zgodnie z wymaganiami projektu. Nie usuwaj edytowalnego pliku projektu, pliku AssemblyInfo ani .vstemplate pliku.

3. Zaktualizuj plik, .vstemplate aby odzwierciedlić wszelkie dodatki i usunięcia. Element Project musi zawierać element ProjectItem dla każdego pliku, który ma zostać uwzględniony w szablonie.

4. Zmodyfikuj pliki kodu i inną zawartość, a następnie dodaj odpowiednie podstawienia parametrów.

5. Zmodyfikuj wygenerowaną zawartość zgodnie z potrzebami.

6. Skompiluj projekt.

   Program Visual Studio tworzy .zip plik zawierający szablon. Nie jest wdrożona i nie jest dostępna w wystąpieniu eksperymentalnym.

Tworzenie szablonu elementu

1. Utwórz projekt szablonu elementu.

   Szablon generuje plik klasy, ikonę .vstemplate , plik i plik AssemblyInfo . Plik klasy zawiera niektóre typowe podstawianie parametrów.

2. Dodaj i usuń elementy z projektu zgodnie z wymaganiami projektu.

3. Zaktualizuj plik, .vstemplate aby odzwierciedlić wszelkie dodatki i usunięcia. Element Project musi zawierać element ProjectItem dla każdego pliku, który ma zostać uwzględniony w szablonie.

4. Zmodyfikuj pliki kodu i inną zawartość, a następnie dodaj odpowiednie podstawienia parametrów.

5. Zmodyfikuj wygenerowaną zawartość zgodnie z potrzebami.

6. Skompiluj projekt.

   Program Visual Studio tworzy skompresowany plik zawierający szablon. Nie jest wdrożona i nie jest dostępna w wystąpieniu eksperymentalnym.

Wdrożenie

Aby wdrożyć szablon projektu lub elementu

1. Utwórz projekt VSIX. Aby uzyskać więcej informacji, zobacz szablon projektu VSIX.

2. Ustaw projekt VSIX jako projekt startowy. W Eksplorator rozwiązań wybierz węzeł projektu VSIX, kliknij prawym przyciskiem myszy i wybierz polecenie Ustaw jako projekt startowy.

3. Ustaw projekt szablonu projektu jako element zawartości projektu VSIX. Otwórz plik vsixmanifest. Przejdź do karty Zasoby i wybierz pozycję Nowy.

   1. Ustaw pole Typ na Microsoft.VisualStudio.ProjectTemplate lub Microsoft.VisualStudio.ItemTemplate.

   2. W polu Źródło wybierz opcję Projekt A w bieżącym rozwiązaniu , a następnie wybierz projekt zawierający szablon.

4. Skompiluj rozwiązanie i naciśnij klawisz F5. Zostanie wyświetlone wystąpienie eksperymentalne.

5. W przypadku projektu szablonu projektu powinien zostać wyświetlony szablon projektu w oknie dialogowym Nowy projekt (plik>nowego>projektu) w węźle Visual C# lub Visual Basic. W przypadku projektu szablonu elementu powinien zostać wyświetlony szablon elementu w oknie dialogowym Dodawanie nowego elementu . Aby wyświetlić okno dialogowe Dodawanie nowego elementu, w Eksplorator rozwiązań wybierz węzeł projektu i wybierz pozycję Dodaj>nowy element.

Zobacz też

• Dokumentacja szablonu programu Visual Studio
• Pakiety NuGet w szablonach programu Visual Studio