Creación de plantillas de proyecto y de elemento personalizadas

  • Artículo

El SDK de Visual Studio incluye plantillas de proyecto que crean una plantilla de proyecto personalizada y una plantilla de elemento personalizado. Estas plantillas incluyen algunas sustituciones de parámetros comunes y se compilan como archivos zip. No se implementan automáticamente y no están disponibles en la instancia experimental. Debe copiar el archivo zip generado en el directorio de plantillas de usuario.

Las plantillas de creación de plantillas le permiten incluir plantillas con extensiones de mayor tamaño. Esto le permite implementar el control de versiones en los archivos de origen y compilar un grupo de proyectos de plantilla en un paquete VSIX.

También puede configurar una plantilla para instalar paquetes NuGet. Para obtener más información, consulte Paquetes NuGet en plantillas de Visual Studio.

Para los escenarios de creación de plantillas básicas, debe usar el asistente para exportar plantillas, el cual genera los resultados a un archivo comprimido. Para obtener más información sobre la creación de plantillas básicas, consulte Crear plantillas de proyecto y elemento.

Nota:

A partir de Visual Studio 2017, ya no se realiza el examen de plantillas de proyecto y elemento personalizadas. En su lugar, la extensión debe proporcionar archivos de manifiesto de plantilla que describan la ubicación de instalación de estas plantillas. Puede usar Visual Studio para actualizar las extensiones VSIX. Si implementa la extensión mediante un archivo MSI, debe generar los archivos de manifiesto de plantilla manualmente. Para obtener más información, consulte Actualización de plantillas de proyecto y elemento para Visual Studio 2017 personalizadas. El esquema de manifiesto de plantilla se documenta en Referencia de esquema de manifiesto de plantillas de Visual Studio.

Crear una plantilla de proyecto

  1. Cree un proyecto de plantilla de proyecto. Puede encontrar la plantilla de proyecto en el cuadro de diálogo Nuevo proyecto buscando "plantilla de proyecto" y seleccionando la versión C# o Visual Basic.

    La plantilla genera un archivo de clase, un icono, un .vstemplate archivo, un archivo de proyecto editable denominado ProjectTemplate.vbproj o ProjectTemplate.csproj y algunos archivos generados normalmente por otros tipos de proyecto, como un archivo resources.resx , un archivo AssemblyInfo y un .settings archivo. Cada archivo de código contiene sustituciones de parámetros comunes donde corresponda.

    Screenshot of project template project selection.

  2. Agregue y quite elementos del proyecto según sea necesario para el proyecto. No quite el archivo de proyecto editable, el archivo AssemblyInfo ni el .vstemplate archivo .

  3. Actualice el .vstemplate archivo para reflejar las adiciones y eliminaciones. El elemento Project debe contener un elemento ProjectItem para cada archivo que se va a incluir en la plantilla.

  4. Modifique los archivos de código y otros contenidos orientados al usuario y agregue las sustituciones de parámetros adecuadas.

  5. Modifique el contenido generado según sea necesario.

  6. Compile el proyecto.

    Visual Studio crea un .zip archivo que contiene la plantilla. No se implementa y no está disponible en la instancia experimental.

Creación de una plantilla de elemento

  1. Cree un proyecto de plantilla de elemento.

    La plantilla genera un archivo de clase, un icono, un .vstemplate archivo y un archivo AssemblyInfo . El archivo de clase contiene algunas sustituciones de parámetros comunes.

  2. Agregue y quite elementos del proyecto según sea necesario para el proyecto.

  3. Actualice el .vstemplate archivo para reflejar las adiciones y eliminaciones. El elemento Project debe contener un elemento ProjectItem para cada archivo que se va a incluir en la plantilla.

  4. Modifique los archivos de código y otros contenidos orientados al usuario y agregue las sustituciones de parámetros adecuadas.

  5. Modifique el contenido generado según sea necesario.

  6. Compile el proyecto.

    Visual Studio crea un archivo comprimido que contiene la plantilla. No se implementa y no está disponible en la instancia experimental.

Implementación

Para implementar la plantilla de proyecto o de elemento

  1. Crear un proyecto de VSIX. Para obtener más información, consulte Plantilla de proyecto VSIX.

  2. Establezca el proyecto VSIX como proyecto de inicio. En el Explorador de soluciones, seleccione el nodo del proyecto VSIX, haga clic con el botón derecho y, después, seleccione Establecer como proyecto de inicio.

  3. Establezca el proyecto de plantilla de proyecto como un recurso del proyecto VSIX. Abra el archivo .vsixmanifest. Cambie a la pestaña Recursos y haga clic en Nuevo.

    1. Establezca el campo Tipo en Microsoft.VisualStudio.ProjectTemplate o Microsoft.VisualStudio.ItemTemplate.

    2. Para el origen, seleccione la opción Un proyecto en la solución actual y posteriormente seleccione el proyecto que contiene la plantilla.

  4. Compile la solución y presione F5. Aparece la instancia experimental.

  5. En el caso de un proyecto de plantilla de proyecto, debería ver la plantilla de proyecto en el cuadro de diálogo Nuevo proyecto (Archivo>Nuevo>Proyecto), en el nodo Visual C# o Visual Basic. Para un proyecto de plantilla de elemento, debería aparecer la plantilla de elemento en el cuadro de diálogo Agregar nuevo elemento. Para ver el cuadro de diálogo Agregar nuevo elemento desde el Explorador de soluciones, seleccione el nodo del proyecto y seleccione Agregar>Nuevo elemento).

Consulte también