Compilar los mismos archivos de código fuente con diferentes opciones

  • Artículo

Al compilar proyectos, con frecuencia se compilan los mismos componentes con distintas opciones de compilación. Por ejemplo, puede crear una compilación de depuración con información de símbolos o una compilación de versión sin información de símbolos, pero con optimizaciones habilitadas. También puede compilar un proyecto que se ejecute en una plataforma concreta, como x86 o x64. En todos estos casos, la mayoría de las opciones de compilación permanecen iguales; solo unas cuantas opciones cambian para controlar la configuración de compilación. Con MSBuild, se utilizan propiedades y condiciones para crear configuraciones de compilación diferentes.

Uso de propiedades para controlar la configuración de compilación

El elemento Property define una variable a la cual se hace referencia varias veces en un archivo de proyecto, como la ubicación de un directorio temporal, o para establecer los valores de propiedades que se utilizan en varias configuraciones, como una compilación de depuración y una compilación de versión. Para más información sobre las propiedades, consulte Propiedades de MSBuild.

Puede usar las propiedades para cambiar la configuración de la compilación sin tener que cambiar el archivo de proyecto. El atributo Condition de los elementos Property y PropertyGroup le permite cambiar el valor de las propiedades. Para obtener más información sobre las condiciones de MSBuild, consulte Condiciones.

Para establecer un grupo de propiedades que depende de otra propiedad

  • Utilice un atributo Condition en un elemento PropertyGroup similar al siguiente:

    <PropertyGroup Condition="'$(Flavor)'=='DEBUG'">
    <DebugType>full</DebugType>
    <Optimize>no</Optimize>
</PropertyGroup>

Para definir una propiedad que depende de otra propiedad

  • Utilice un atributo Condition en un elemento Property similar al siguiente:

    <DebugType Condition="'$(Flavor)'=='DEBUG'">full</DebugType>

Especificar propiedades en la línea de comandos

Una vez que el archivo de proyecto está escrito para aceptar varias configuraciones, debe tener la capacidad de cambiar dichas configuraciones siempre que compile el proyecto. MSBuild proporciona esta capacidad al permitir especificar propiedades en la línea de comandos mediante los modificadores -property o -p.

Para establecer una propiedad de proyecto en la línea de comandos

  • Utilice el modificador -property con la propiedad y el valor de la propiedad. Por ejemplo:

    msbuild file.proj -property:Flavor=Debug

    or

    Msbuild file.proj -p:Flavor=Debug

Para especificar más de una propiedad del proyecto en la línea de comandos

  • Use el modificador -property o -p varias veces con la propiedad y los valores de la propiedad, o use un modificador -property o -p y separe varias propiedades con punto y coma (;). Por ejemplo:

    msbuild file.proj -p:Flavor=Debug;Platform=x86

    or

    msbuild file.proj -p:Flavor=Debug -p:Platform=x86

    Las variables de entorno también se tratan como propiedades y se incorporan automáticamente mediante MSBuild. Para obtener más información sobre cómo usar variables de entorno, vea Cómo: Usar variables de entorno al compilar.

    El valor de propiedad que se especifica en la línea de comandos tiene prioridad sobre cualquier valor que se establece para la misma propiedad en el archivo de proyecto, y ese valor en el archivo de proyecto tiene prioridad sobre el valor de una variable de entorno.

    Puede cambiar este comportamiento mediante el atributo TreatAsLocalProperty en una etiqueta de proyecto. Para los nombres de propiedad que se muestran con ese atributo, el valor de propiedad que se especifica en la línea de comandos no tiene prioridad sobre el valor en el archivo de proyecto. Más adelante en este tema encontrará un ejemplo.

Ejemplo 1

El ejemplo de código siguiente, el proyecto "Hello World", contiene dos grupos de propiedades nuevas que se pueden utilizar para crear una compilación de depuración y una compilación de versión.

Para compilar la versión de depuración de este proyecto, escriba:

msbuild consolehwcs1.proj -p:flavor=debug

Para compilar la versión comercial de este proyecto, escriba:

msbuild consolehwcs1.proj -p:flavor=retail

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

    <!-- Sets the default flavor if an environment variable called
    Flavor is not set or specified on the command line -->
    <PropertyGroup>
        <Flavor Condition="'$(Flavor)'==''">DEBUG</Flavor>
    </PropertyGroup>

    <!-- Define the DEBUG settings -->
    <PropertyGroup Condition="'$(Flavor)'=='DEBUG'">
        <DebugType>full</DebugType>
        <Optimize>no</Optimize>
    </PropertyGroup>

    <!-- Define the RETAIL settings -->
    <PropertyGroup Condition="'$(Flavor)'=='RETAIL'">
        <DebugType>pdbonly</DebugType>
        <Optimize>yes</Optimize>
    </PropertyGroup>

    <!-- Set the application name as a property -->
    <PropertyGroup>
        <appname>HelloWorldCS</appname>
    </PropertyGroup>

    <!-- Specify the inputs by type and file name -->
    <ItemGroup>
        <CSFile Include = "consolehwcs1.cs"/>
    </ItemGroup>

    <Target Name = "Compile">
        <!-- Run the Visual C# compilation using input files
        of type CSFile -->
        <CSC  Sources = "@(CSFile)"
            DebugType="$(DebugType)"
            Optimize="$(Optimize)"
            OutputAssembly="$(appname).exe" >

            <!-- Set the OutputAssembly attribute of the CSC
            task to the name of the executable file that is
            created -->
            <Output TaskParameter="OutputAssembly"
                ItemName = "EXEFile" />
        </CSC>
        <!-- Log the file name of the output file -->
        <Message Text="The output file is @(EXEFile)"/>
    </Target>
</Project>

Ejemplo 2

En el ejemplo siguiente se muestra cómo utilizar el atributo TreatAsLocalProperty. La propiedad Color tiene un valor de Blue en el archivo de proyecto y de Green en la línea de comandos. Con TreatAsLocalProperty="Color" en la etiqueta del proyecto, la propiedad en la línea de comandos (Green) no invalida la propiedad que se define en el archivo del proyecto (Blue).

Para compilar el proyecto, escriba el siguiente comando:

msbuild colortest.proj -t:go -property:Color=Green

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"
ToolsVersion="4.0" TreatAsLocalProperty="Color">

    <PropertyGroup>
        <Color>Blue</Color>
    </PropertyGroup>

    <Target Name="go">
        <Message Text="Color: $(Color)" />
    </Target>
</Project>

<!--
  Output with TreatAsLocalProperty="Color" in project tag:
     Color: Blue

  Output without TreatAsLocalProperty="Color" in project tag:
     Color: Green
-->

Contenido relacionado