Share via

同じソース ファイルを異なるオプションでビルドする

  • [アーティクル]

プロジェクトをビルドする場合、同じコンポーネントを異なるビルド オプションでコンパイルすることがよくあります。 たとえば、シンボル情報を付ければデバッグ ビルドを作成でき、シンボル情報なしで最適化を有効にすればリリース ビルドを作成できます。 または、x86 や x64 などの特定のプラットフォーム上で実行するようにプロジェクトをビルドできます。 これらのいずれの場合も、ほとんどのビルド オプションは同じままで、ビルド構成を制御するためにいくつかのオプションが変更されるだけです。 MSBuild では、異なるビルド構成を作成するためにプロパティと条件を使用します。

プロパティを使用してビルド設定を制御する

Property 要素は、一時ディレクトリの場所など、1 つのプロジェクト ファイル内で何回も参照されるような変数を定義したり、デバッグ ビルドとリリース ビルドなど、複数の構成で使用されるプロパティに値を設定したりします。 プロパティの詳細については、「MSBuild プロパティ」をご覧ください。

プロパティは、プロジェクト ファイルを変更せずにビルドの構成を変更するために使用することができます。 Property 要素と PropertyGroup 要素の Condition 属性により、プロパティの値を変更することができます。 MSBuild 条件の詳細については、条件に関する記事をご覧ください。

別のプロパティに依存するプロパティのグループを設定するには

  • PropertyGroup 要素で以下のような Condition 属性を使用します。

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

別のプロパティに依存するプロパティを定義するには

  • Property 要素で以下のような Condition 属性を使用します。

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

コマンド ラインでプロパティを指定する

複数の構成を受け入れるようにプロジェクト ファイルを作成したら、プロジェクトをビルドするときに構成を変更できなければなりません。 それができるように、MSBuild では、コマンド ラインで -property または -p スイッチを使用してプロパティを指定できるようになっています。

コマンド ライン上でプロジェクト プロパティを設定するには

  • -property スイッチをプロパティおよびプロパティ値と共に使用します。 たとえば次のような点です。

    msbuild file.proj -property:Flavor=Debug

    or

    Msbuild file.proj -p:Flavor=Debug

コマンド ライン上で 2 つ以上のプロジェクト プロパティを指定するには

  • -property または -p スイッチをプロパティおよびプロパティ値と共に複数回使用するか、-property または -p スイッチを 1 回使用し、複数のプロパティをセミコロン (;) で分けます。 たとえば次のような点です。

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

    or

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

    環境変数はプロパティとしても扱われ、MSBuild によって自動的に組み込まれます。 環境変数の使用に関する詳細については、「方法: ビルドで環境変数を使用する」を参照してください。

    コマンド ラインで指定されたプロパティ値は、同じプロパティに対してプロジェクト ファイル内で設定されているどの値よりも優先され、プロジェクト ファイル内の値は環境変数の値よりも優先されます。

    この動作は、プロジェクト タグの TreatAsLocalProperty 属性を使用して変更できます。 その属性と共に記載されたプロパティ名については、コマンド ラインで指定されたプロパティ値がプロジェクト ファイル内の値よりも優先されることはありません。 このトピックの後の部分でその例を示します。

例 1

以下の "Hello World" プロジェクトのコード例には、デバッグ ビルドとリリース ビルドを作成するために使用できる 2 つの新しいプロパティ グループが含まれています。

このプロジェクトのデバッグ バージョンをビルドするには、以下のように入力します。

msbuild consolehwcs1.proj -p:flavor=debug

このプロジェクトのリテール バージョンをビルドするには、以下のように入力します。

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>

例 2

次の例は、TreatAsLocalProperty 属性を使用する方法を示しています。 Color プロパティはプロジェクト ファイル内では値 Blue であり、コマンド ライン上では値 Green です。 プロジェクト タグ内に TreatAsLocalProperty="Color" がある場合、コマンド ライン上のプロパティ (Green) はプロジェクト ファイル内で定義されているプロパティ (Blue) をオーバーライドしません。

プロジェクトをビルドするには、次のコマンドを入力します。

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
-->

関連するコンテンツ