チュートリアル: MSBuild プロジェクトファイルのゼロからの作成

[アーティクル]
02/21/2013

Visual C# や Visual Basic など、.NET Framework を対象とするプログラミング言語では、MSBuild プロジェクトファイルを使用してアプリケーションのビルド処理を記述および制御します。Visual Studio を使用して MSBuild プロジェクトファイルを作成すると、適切な XML が自動的に追加されますが、その XML がどのように構成されているかや、それに変更を加えてビルドを制御するにはどうすればよいかを知っておくことも有用です。このチュートリアルでは、テキストエディターのみを使用して、基本的なプロジェクトファイルをインクリメント方式で作成する方法について説明します。このチュートリアルの手順を以下に示します。

最低限の内容のみを含むアプリケーションソースファイルを作成します。
最低限の内容のみを含む MSBuild プロジェクトファイルを作成します。
MSBuild が含まれるように PATH 環境変数を拡張します。
プロジェクトファイルを使用してアプリケーションをビルドします。
ビルドを制御するためのプロパティを追加します。
プロパティの値を変更してビルドを制御します。
ビルドターゲットを追加します。
ターゲットを指定してビルドを制御します。
インクリメンタルビルドを実行します。

このチュートリアルでは、コマンドプロンプトでプロジェクトをビルドして結果を確認する方法を説明します。MSBuild の詳細および MSBuild をコマンドプロンプトで実行する方法の詳細については、「チュートリアル: MSBuild の使用」を参照してください。

このチュートリアルを実行するには、.NET Framework (Version 2.0、3.5、または 4) がインストールされている必要があります。これらには、このチュートリアルに必要な MSBuild と Visual C# コンパイラが含まれています。

最低限の内容のみを含むアプリケーションを作成する

ここでは、最低限の内容のみを含む Visual C# アプリケーションソースファイルをテキストエディターで作成する方法を説明します。

最低限の内容のみを含むアプリケーションを作成するには

コマンドプロンプトで、アプリケーションを作成するフォルダーに移動します (\My Documents\、\Desktop\ など)。
「md HelloWorld」と入力して、\HelloWorld\ というサブフォルダーを作成します。
「cd HelloWorld」と入力して、その新しいフォルダーに移動します。

メモ帳またはその他のテキストエディターを起動して、次のコードを入力します。

using System;

class HelloWorld
{
    static void Main()
    {
#if DebugConfig
        Console.WriteLine("WE ARE IN THE DEBUG CONFIGURATION");
#endif

        Console.WriteLine("Hello, world!");
    }
}

このソースコードファイルを Helloworld.cs という名前で保存します。
コマンドプロンプトで「csc helloworld.cs」と入力して、アプリケーションをビルドします。
コマンドプロンプトで「helloworld」と入力して、アプリケーションをテストします。

"Hello, world!" というメッセージが表示されます。
コマンドプロンプトで「del helloworld.exe」と入力して、アプリケーションを削除します。

最低限の内容のみを含む MSBuild プロジェクトファイルを作成する

最低限の内容のみを含むアプリケーションソースファイルを作成できたので、次に、そのアプリケーションをビルドするための最低限の内容のみを含むプロジェクトファイルを作成します。このプロジェクトファイルに含まれる要素は次のとおりです。

必須のルート Project ノード
項目要素を格納する ItemGroup ノード
アプリケーションソースファイルを参照する項目要素
アプリケーションをビルドするために必要なタスクを格納する Target ノード
アプリケーションをビルドするために Visual C# コンパイラを起動する Task 要素

最低限の内容のみを含む MSBuild プロジェクトファイルを作成するには

テキストエディターで、既存のテキストを次の 2 つの行に置き換えます。
```
<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
</Project>
```
次の ItemGroup ノードを Project ノードの子要素として挿入します。
```
  <ItemGroup>
    <Compile Include="helloworld.cs" />
  </ItemGroup>
```
この ItemGroup には既に項目要素が含まれています。
Project ノードの子要素として Target ノードを追加します。そのノードに "Build" という名前を付けます。
```
  <Target Name="Build">
  </Target>
```
次のタスク要素を Target ノードの子要素として挿入します。
```
    <Csc Sources="@(Compile)"/>
```
このプロジェクトファイルを Helloworld.csproj という名前で保存します。

最低限の内容のみを含むプロジェクトファイルが完成すると、コードが次のようになります。

<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
  <ItemGroup>
    <Compile Include="helloworld.cs" />
  </ItemGroup>
  <Target Name="Build">
    <Csc Sources="@(Compile)"/>  
  </Target>
</Project>

Build ターゲットのタスクは順番に実行されます。ここでは、Visual C# コンパイラの Csc タスクが唯一のタスクです。このタスクは、コンパイルするソースファイルのリストを受け取ります。これは、Compile 項目の値によって渡されます。Compile 項目は、Helloworld.cs という 1 つのソースファイルのみを参照しています。

[!メモ]

項目要素でワイルドカード文字のアスタリスク (*) を使用して、拡張子 .cs を持つすべてのファイルを参照することもできます。次に例を示します。

<Compile Include="*.cs" />

ただし、ワイルドカード文字を使用すると、ソースファイルを追加または削除した場合にデバッグやターゲットの選択が困難になるため、できるだけ使用しないようにしてください。

MSBuild が含まれるようにパスを拡張する

MSBuild を使用するには、.NET Framework フォルダーが含まれるように PATH 環境変数を拡張する必要があります。

MSBuild が含まれるようにパスを拡張するには

コマンドプロンプトで、「set PATH=%PATH%;%WINDIR%\Microsoft.Net\Framework\v4.0」と入力します。別のバージョンの .NET Framework がインストールされている場合は、それに合わせてバージョン番号を変更してください。

[!メモ]

コンピューターの MSBuild フォルダーの名前に v2.0.50727 などのビルド番号が含まれている場合は、コマンドラインにそのビルド番号を含めてください (例: set PATH=%PATH%;%WINDIR%\Microsoft.Net\Framework\v2.0.50727)。

Visual Studio がインストールされている場合は、Visual Studio コマンドプロンプトを使用することもできます。Visual Studio コマンドプロンプトでは、MSBuild フォルダーへのパスが設定されています。

プロジェクトファイルを使用してアプリケーションをビルドする

次に、先ほど作成したプロジェクトファイルを使用してアプリケーションをビルドします。

アプリケーションをビルドするには

コマンドプロンプトで、「msbuild helloworld.csproj /t:Build」と入力します。

Visual C# コンパイラが呼び出され、Helloworld プロジェクトファイルの Build ターゲットがビルドされて、Helloworld アプリケーションが作成されます。
「helloworld」と入力してアプリケーションをテストします。

"Hello, world!" というメッセージが表示されます。

[!メモ]

詳細レベルを上げると、ビルドの詳細情報を表示できます。詳細レベルを "detailed" に設定するには、コマンドプロンプトで次のいずれかのコマンドを入力します。

msbuild helloworld.csproj /t:Build /verbosity:detailed

ビルドプロパティを追加する

プロジェクトファイルにビルドプロパティを追加すると、ビルドをさらに細かく制御できます。ここでは、次のプロパティを追加します。

アプリケーションの名前を指定する AssemblyName プロパティ
アプリケーションを格納するフォルダーを指定する OutputPath プロパティ

ビルドプロパティを追加するには

コマンドプロンプトで「del helloworld.exe」と入力して、既存のアプリケーションを削除します。

プロジェクトファイルで、次の PropertyGroup 要素を開始 Project 要素の直後に挿入します。

  <PropertyGroup>
    <AssemblyName>MSBuildSample</AssemblyName>
    <OutputPath>Bin\</OutputPath>
  </PropertyGroup>

次のタスクを Build ターゲットの Csc タスクの直前に追加します。
```
    <MakeDir Directories="$(OutputPath)"      Condition="!Exists('$(OutputPath)')" />
```
この MakeDir タスクは、OutputPath プロパティによって指定されるフォルダーを、同名のフォルダーが存在しない場合に作成します。
次の OutputAssembly 属性を Csc タスクに追加します。
```
<Csc Sources="@(Compile)" OutputAssembly="$(OutputPath)$(AssemblyName).exe" />
```
この属性は、Visual C# コンパイラに対して、AssemblyName プロパティによって指定されるアセンブリを生成し、OutputPath プロパティによって指定されるフォルダーに配置するように指定します。
変更内容を保存します。

プロジェクトファイルのコードが次のようになります。

<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <AssemblyName>MSBuildSample</AssemblyName>
    <OutputPath>Bin\</OutputPath>
  </PropertyGroup>
  <ItemGroup>
    <Compile Include="helloworld.cs" />
  </ItemGroup>
  <Target Name="Build">
    <MakeDir Directories="$(OutputPath)" Condition="!Exists('$(OutputPath)')" />
    <Csc Sources="@(Compile)" OutputAssembly="$(OutputPath)$(AssemblyName).exe" />
  </Target>
</Project>

[!メモ]

パス区切り記号の円記号 (\) は、Csc タスクの OutputAssembly 属性に追加するのではなく、OutputPath 要素で指定するフォルダー名の末尾に追加することをお勧めします。次に例を示します。

<OutputPath>Bin\</OutputPath>

OutputAssembly=="$(OutputPath)$(AssemblyName).exe" />

この形式が次の形式より推奨されます。

<OutputPath>Bin</OutputPath>

OutputAssembly=="$(OutputPath)\$(AssemblyName).exe" />

ビルドプロパティをテストする

次に、ビルドプロパティで出力フォルダーとアプリケーション名を指定したプロジェクトファイルを使用してアプリケーションをビルドします。

ビルドプロパティをテストするには

コマンドプロンプトで、「msbuild helloworld.csproj /t:Build」と入力します。

\Bin\ フォルダーが作成され、Visual C# コンパイラが呼び出されて、MSBuildSample アプリケーションが作成されて \Bin\ フォルダーに配置されます。
「dir Bin」と入力して、\Bin\ フォルダーが作成されていることと、そこに MSBuildSample アプリケーションが含まれていることを確認します。
「Bin\MSBuildSample」と入力してアプリケーションをテストします。

"Hello, world!" というメッセージが表示されます。

ビルドターゲットを追加する

次に、次の 2 つのターゲットをプロジェクトファイルに追加します。

古いファイルを削除する Clean ターゲット
DependsOnTargets 属性を使用して Build タスクの前に強制的に Clean タスクを実行する Rebuild ターゲット

ターゲットが複数になるので、Build ターゲットを既定のターゲットに設定します。

ビルドターゲットを追加するには

プロジェクトファイルで、Build ターゲットの直後に次の 2 つのターゲットを追加します。
```
  <Target Name="Clean" >
    <Delete Files="$(OutputPath)$(AssemblyName).exe" />
  </Target>
  <Target Name="Rebuild" DependsOnTargets="Clean;Build" />
```
Clean ターゲットは、Delete タスクを呼び出してアプリケーションを削除します。Rebuild ターゲットは、Clean ターゲットと Build ターゲットの両方が実行されるまで実行されません。Rebuild ターゲットにはタスクは含まれていませんが、このターゲットにより、Build ターゲットの前に Clean ターゲットが実行されるようになります。
次の DefaultTargets 属性を開始 Project 要素に追加します。
```
<Project DefaultTargets="Build" xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
```
これにより、Build ターゲットが既定のターゲットに設定されます。

プロジェクトファイルのコードが次のようになります。

<Project DefaultTargets="Build" xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <AssemblyName>MSBuildSample</AssemblyName>
    <OutputPath>Bin\</OutputPath>
  </PropertyGroup>
  <ItemGroup>
    <Compile Include="helloworld.cs" />
  </ItemGroup>
  <Target Name="Build">
    <MakeDir Directories="$(OutputPath)" Condition="!Exists('$(OutputPath)')" />
    <Csc Sources="@(Compile)" OutputAssembly="$(OutputPath)$(AssemblyName).exe" />
  </Target>
  <Target Name="Clean" >
    <Delete Files="$(OutputPath)$(AssemblyName).exe" />
  </Target>
  <Target Name="Rebuild" DependsOnTargets="Clean;Build" />
</Project>

ビルドターゲットをテストする

新しいビルドターゲットを使用して、プロジェクトファイルの以下の機能をテストします。

既定のビルドをビルドする。
コマンドプロンプトでアプリケーション名を設定する。
別のアプリケーションをビルドする前にアプリケーションを削除する。
別のアプリケーションをビルドせずにアプリケーションを削除する。

ビルドターゲットをテストするには

コマンドプロンプトで、「msbuild helloworld.csproj /p:AssemblyName=Greetings」と入力します。

/t スイッチを使用してターゲットを明示的に設定していないため、既定の Build ターゲットがビルドされます。/p スイッチでは、AssemblyName プロパティをオーバーライドして新しい値 "Greetings" を割り当てています。これにより、Greetings.exe という新しいアプリケーションが \Bin\ フォルダーに作成されます。
「dir Bin」と入力して、\Bin\ フォルダーに MSBuildSample アプリケーションと新しい Greetings アプリケーションの両方が含まれていることを確認します。
「Bin\Greetings」と入力して、Greetings アプリケーションをテストします。

"Hello, world!" というメッセージが表示されます。
「msbuild helloworld.csproj /t:clean」と入力して、MSBuildSample アプリケーションを削除します。

Clean タスクが実行されて、AssemblyName プロパティの値が既定値の "MSBuildSample" になっているアプリケーションが削除されます。
「msbuild helloworld.csproj /t:clean /p:AssemblyName=Greetings」と入力して、Greetings アプリケーションを削除します。

Clean タスクが実行されて、AssemblyName プロパティの値が、指定した値 "Greetings" になっているアプリケーションが削除されます。
「dir Bin」と入力して、\Bin\ フォルダーが空になったことを確認します。
「msbuild」と入力します。

プロジェクトファイルが指定されていませんが、現在のフォルダーにはプロジェクトファイルが 1 つしかないため、helloworld.csproj ファイルがビルドされます。その結果、\Bin\ フォルダーに MSBuildSample アプリケーションが作成されます。

「dir Bin」と入力して、\Bin\ フォルダーに MSBuildSample アプリケーションが含まれていることを確認します。

インクリメンタルビルドを実行する

MSBuild では、ターゲットが依存しているソースファイルやターゲットファイルが変更された場合にのみターゲットをビルドすることができます。ファイルが変更されているかどうかはファイルのタイムスタンプを使用して特定されます。

インクリメンタルビルドを実行するには

プロジェクトファイルで、開始 Build ターゲットに次の属性を追加します。
```
Inputs="@(Compile)" Outputs="$(OutputPath)$(AssemblyName).exe"
```
ここでは、Compile 項目グループに指定されている入力ファイルに Build ターゲットが依存していること、出力対象がアプリケーションファイルであることを指定しています。

この結果、Build ターゲットのコードは次のようになります。
```
<Target Name="Build" Inputs="@(Compile)" Outputs="$(OutputPath)$(AssemblyName).exe">
  <MakeDir Directories="$(OutputPath)" Condition="!Exists('$(OutputPath)')" />
  <Csc Sources="@(Compile)" OutputAssembly="$(OutputPath)$(AssemblyName).exe" />
</Target>
```
コマンドプロンプトで「msbuild /v:d」と入力して、Build ターゲットをテストします。

helloworld.csproj が既定のプロジェクトファイルであること、Build が既定のターゲットであることに注意してください。

/v:d スイッチは、ビルド処理の詳細な説明を表示するように指定します。

以下の行が表示されます。

Skipping target "Build" because all output files are up-to-date with respect to the input files.

Input files: HelloWorld.cs

Output files: Bin\MSBuildSample.exe

アプリケーションがビルドされてから変更されたソースファイルがないため、Build ターゲットはスキップされます。

例

Description

次の例は、Visual C# アプリケーションをコンパイルし、出力ファイル名を含むメッセージを記録するプロジェクトファイルを示しています。

コード

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

    <!-- 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)"
            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>

例

Description

次の例は、Visual Basic アプリケーションをコンパイルするプロジェクトファイルを表示し、出力ファイル名を含むメッセージを記録します。

コード

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

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

    <!-- Specify the inputs by type and file name -->
    <ItemGroup>
        <VBFile Include = "consolehwvb1.vb"/>
    </ItemGroup>

    <Target Name = "Compile">    
        <!-- Run the Visual Basic compilation using input files of type VBFile -->
        <VBC
            Sources = "@(VBFile)"
            OutputAssembly= "$(appname).exe">
            <!-- Set the OutputAssembly attribute of the VBC task
            to the name of the executable file that is created -->
            <Output
                TaskParameter = "OutputAssembly"
                ItemName = "EXEFile" />
        </VBC>
        <!-- Log the file name of the output file -->
        <Message Text="The output file is @(EXEFile)"/>
    </Target>
</Project>

次の内容

このチュートリアルで説明した作業の大半は、Visual Studio で自動的に実行できます。Visual Studio を使用して MSBuild プロジェクトファイルを作成、編集、ビルド、およびテストする方法については、「チュートリアル: MSBuild の使用」を参照してください。

参照

その他の技術情報

MSBuild

MSBuild リファレンス

次の方法で共有

チュートリアル: MSBuild プロジェクトファイルのゼロからの作成

最低限の内容のみを含むアプリケーションを作成する

最低限の内容のみを含むアプリケーションを作成するには

最低限の内容のみを含む MSBuild プロジェクトファイルを作成する

最低限の内容のみを含む MSBuild プロジェクトファイルを作成するには

MSBuild が含まれるようにパスを拡張する

MSBuild が含まれるようにパスを拡張するには

プロジェクトファイルを使用してアプリケーションをビルドする

アプリケーションをビルドするには

ビルドプロパティを追加する

ビルドプロパティを追加するには

ビルドプロパティをテストする

ビルドプロパティをテストするには

ビルドターゲットを追加する

ビルドターゲットを追加するには

ビルドターゲットをテストする

ビルドターゲットをテストするには

インクリメンタルビルドを実行する

インクリメンタルビルドを実行するには

例

Description

コード

例

Description

コード

次の内容

参照

その他の技術情報

その他のリソース

次の方法で共有

チュートリアル: MSBuild プロジェクト ファイルのゼロからの作成

最低限の内容のみを含むアプリケーションを作成する

最低限の内容のみを含むアプリケーションを作成するには

最低限の内容のみを含む MSBuild プロジェクト ファイルを作成する

最低限の内容のみを含む MSBuild プロジェクト ファイルを作成するには

MSBuild が含まれるようにパスを拡張する

MSBuild が含まれるようにパスを拡張するには

プロジェクト ファイルを使用してアプリケーションをビルドする

アプリケーションをビルドするには

ビルド プロパティを追加する

ビルド プロパティを追加するには

ビルド プロパティをテストする

ビルド プロパティをテストするには

ビルド ターゲットを追加する

ビルド ターゲットを追加するには

ビルド ターゲットをテストする

ビルド ターゲットをテストするには

インクリメンタル ビルドを実行する

インクリメンタル ビルドを実行するには

例

Description

コード

例

Description

コード

次の内容

参照

その他の技術情報

その他のリソース

チュートリアル: MSBuild プロジェクトファイルのゼロからの作成

最低限の内容のみを含む MSBuild プロジェクトファイルを作成する

最低限の内容のみを含む MSBuild プロジェクトファイルを作成するには

プロジェクトファイルを使用してアプリケーションをビルドする

ビルドプロパティを追加する

ビルドプロパティを追加するには

ビルドプロパティをテストする

ビルドプロパティをテストするには

ビルドターゲットを追加する

ビルドターゲットを追加するには

ビルドターゲットをテストする

ビルドターゲットをテストするには

インクリメンタルビルドを実行する

インクリメンタルビルドを実行するには