Compartir a través de

Excluir archivos de la compilación

  • Artículo

En un archivo de proyecto puede utilizar comodines para incluir todos los archivos de un directorio o un conjunto de directorios anidado como entradas para una compilación. Sin embargo, puede haber un archivo en el directorio o un directorio en el conjunto anidado de directorios que no quiera incluir como entrada para una compilación. Puede excluir explícitamente ese archivo o directorio de la lista de entradas. También puede haber un archivo en un proyecto que solo quiera incluir bajo determinadas condiciones. Se pueden declarar explícitamente las condiciones para incluir un archivo en una compilación.

Nota:

Las técnicas descritas en este artículo no son aplicables a F# ni C++. Esos sistemas de proyecto administran los propios archivos de origen.

Exclusión de un archivo mediante Visual Studio

Si usa Visual Studio, seleccione el archivo en el Explorador de soluciones, vea la ventana Propiedades (presione Alt+Entrar) y establezca la acción de compilación en Ninguno.

Esto da como resultado los siguientes cambios en el archivo de proyecto de MSBuild:

  <ItemGroup>
    <Compile Remove="ClassToExclude.cs" />
  </ItemGroup>

  <ItemGroup>
    <None Include="ClassToExclude.cs" />
  </ItemGroup>

Esto funciona bien para algunos archivos, pero no se escala verticalmente a un mayor número de archivos o archivos que coinciden con un patrón determinado. En los proyectos de .NET, puede usar MSBuild para excluir archivos y directorios mediante una expresión comodín, también denominada glob, como se describe a continuación.

Exclusión de archivos o directorios en proyectos de .NET

Las listas de elementos son los archivos de entrada para una compilación. Para la mayoría de los proyectos, como los proyectos del SDK de .NET, hay listas de elementos predefinidos de distintos tipos de elementos (por ejemplo, Compile para archivos de código fuente, Content para determinados archivos estáticos, etc.) que ya están definidos por las importaciones estándar. Puede encontrar una lista de estos elementos en Elementos comunes del proyecto de MSBuild. En el código del proyecto, estos están predefinidos para incluir todo lo pertinente; por ejemplo, Compile en un proyecto de C# incluye todos los archivos con la extensión .cs.

Para excluir archivos, puede usar el atributo Remove en el elemento.

<ItemGroup>
   <Compile Remove="ClassToExclude.cs" />
</ItemGroup>

Puede especificar varios archivos individuales o varios patrones globales:

<ItemGroup>
   <Compile Remove="Contoso*.cs" /> <!-- Wildcard on filename -->
   <Compile Remove="File1.cs;File2.cs" /> <!-- List of files with separator -->
   <Compile Remove="Contoso/**/*.cs" /> <!-- All .cs files in a directory subtree -->
</ItemGroup>

Para obtener una lista de patrones admitidos, consulte Formatos de patrón.

Incluir y excluir archivos o directorios en el lenguaje MSBuild

En el lenguaje MSBuild sin procesar (es decir, sin ninguna de las importaciones estándar o referencia a un SDK), los elementos que desea incluir se declaran por separado o como un grupo mediante el atributo Include. Por ejemplo:

<CSFile Include="Form1.cs"/>
<CSFile Include ="File1.cs;File2.cs"/>
<CSFile Include="*.cs"/>
<JPGFile Include="Images\**\*.jpg"/>

Si se han utilizado comodines para incluir todos los archivos de un directorio o un conjunto de directorios anidado como entradas para una compilación, puede haber uno o más archivos en el directorio o un directorio en el conjunto de directorios anidado que no quiera incluir. Para excluir un elemento de la lista de elementos, utilice el atributo Exclude.

Exclude no es realmente una operación de elemento; no se puede usar por sí mismo, sino solo como modificador para Include.

Para incluir todos los archivos .cs o *.vb excepto Form2

  • Utilice uno de los siguientes atributos Include y Exclude:

    <CSFile Include="*.cs" Exclude="Form2.cs"/>

    o

    <VBFile Include="*.vb" Exclude="Form2.vb"/>

Para incluir todos los archivos .cs o .vb excepto Form2 y Form3

  • Utilice uno de los siguientes atributos Include y Exclude:

    <CSFile Include="*.cs" Exclude="Form2.cs;Form3.cs"/>

    o

    <VBFile Include="*.vb" Exclude="Form2.vb;Form3.vb"/>

Para incluir todos los archivos .jpg de los subdirectorios del directorio Images, excepto los del directorio Version2

  • Utilice los siguientes atributos Include y Exclude:

    <JPGFile
    Include="Images\**\*.jpg"
    Exclude = "Images\**\Version2\*.jpg"/>

    Nota

    Debe especificar la ruta de acceso de ambos atributos. Si utiliza una ruta de acceso absoluta para especificar ubicaciones de archivos en el atributo Include, también debe utilizar una ruta de acceso absoluta en el atributo Exclude; si utiliza una ruta de acceso relativa en el atributo Include, también debe utilizar una ruta de acceso relativa en el atributo Exclude.

Excluir y quitar

Si va a definir sus propias listas de elementos, debe usar Exclude siempre que sea posible. Hay una ventaja de rendimiento para usar Exclude en la misma declaración que Include, ya que los elementos que se excluirían no tienen que procesarse.

Use Remove cuando tenga una lista de elementos predefinida, como en el caso de las listas de elementos estándar como Compile y Content. En ese caso, Exclude no se admite.

Nota:

Si usa un SDK que lo admita, puede establecer la propiedad $(OverrideDefaultCompileItems) en true y definir su propio elemento Compile con Include y, opcionalmente, Exclude.

Usar condiciones para excluir un archivo o un directorio de las entradas de una compilación

Si hay elementos que quiere incluir, por ejemplo, en una compilación de depuración, pero no en una compilación de versión, puede utilizar el atributo Condition para especificar las condiciones en las que se va a incluir el elemento.

Para incluir el archivo Formula.vb solo en compilaciones de versión

  • Utilice un atributo Condition similar al siguiente:

    <Compile
    Include="Formula.vb"
    Condition=" '$(Configuration)' == 'Release' " />

Ejemplo

En el ejemplo de código siguiente se compila un proyecto con todos los archivos .cs del directorio, excepto Form2.cs.

<Project DefaultTargets="Compile"
    xmlns="http://schemas.microsoft.com/developer/msbuild/2003" >

    <PropertyGroup>
        <builtdir>built</builtdir>
    </PropertyGroup>

    <ItemGroup>
        <CSFile Include="*.cs" Exclude="Form2.cs"/>

        <Reference Include="System.dll"/>
        <Reference Include="System.Data.dll"/>
        <Reference Include="System.Drawing.dll"/>
        <Reference Include="System.Windows.Forms.dll"/>
        <Reference Include="System.XML.dll"/>
    </ItemGroup>

    <Target Name="PreBuild">
        <Exec Command="if not exist $(builtdir) md $(builtdir)"/>
    </Target>

    <Target Name="Compile" DependsOnTargets="PreBuild">
        <Csc Sources="@(CSFile)"
            References="@(Reference)"
            OutputAssembly="$(builtdir)\$(MSBuildProjectName).exe"
            TargetType="exe" />
    </Target>
</Project>

Contenido relacionado