.NET SDK プロジェクトの MSBuild リファレンス

このページは、.NET プロジェクトの構成に使用できる MSBuild のプロパティと項目のリファレンスです。

アセンブリ検証プロパティ

これらのプロパティと項目は、ValidateAssemblies タスクに渡されます。 アセンブリの検証の詳細については、「アセンブリの検証」を参照してください。

このセクションでは、次の MSBuild プロパティについて説明します。

• ApiCompatStrictMode
• ApiCompatValidateAssemblies

さらに、「パッケージ検証プロパティ」に記載されている次のプロパティは、アセンブリの検証にも適用されます。

• ApiCompatEnableRuleAttributesMustMatch
• ApiCompatEnableRuleCannotChangeParameterName
• ApiCompatExcludeAttributesFile
• ApiCompatGenerateSuppressionFile
• ApiCompatPermitUnnecessarySuppressions
• ApiCompatPreserveUnnecessarySuppressions
• ApiCompatRespectInternals
• ApiCompatSuppressionFile
• ApiCompatSuppressionOutputFile
• NoWarn
• RoslynAssembliesPath

ApiCompatStrictMode

true プロパティに設定すると、API 互換性チェックをApiCompatStrictModeで実行する必要があることが プロパティにより指定されます。

<PropertyGroup>
  <ApiCompatStrictMode>true</ApiCompatStrictMode>
</PropertyGroup>

ApiCompatValidateAssemblies

ApiCompatValidateAssemblies プロパティを使用すると、指定したアセンブリに対して一連の検証を実行できます。 詳細については、「アセンブリ検証」を参照してください。

<PropertyGroup>
  <ApiCompatValidateAssemblies>true</ApiCompatValidateAssemblies>
</PropertyGroup>

アセンブリの属性プロパティ

• GenerateAssemblyInfo
• GeneratedAssemblyInfoFile
• IncludeSourceRevisionInInformationalVersion
• SourceRevisionId

GenerateAssemblyInfo

GenerateAssemblyInfo プロパティによってプロジェクトの AssemblyInfo 属性の生成を制御できます。 既定値は true です。 ファイルの生成を無効にするには、false を使用します。

<PropertyGroup>
  <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
</PropertyGroup>

GeneratedAssemblyInfoFile 設定は、生成されるファイルの名前を制御します。

GenerateAssemblyInfo 値が true の場合、パッケージ関連のプロジェクト プロパティがアセンブリ属性に変換されます。

プロジェクト ファイルを使用してアセンブリ属性を生成する方法の詳細については、「プロジェクト ファイルでアセンブリ属性を設定する」を参照してください。

GeneratedAssemblyInfoFile

GeneratedAssemblyInfoFile プロパティによって、生成されるアセンブリ情報ファイルの相対パスまたは絶対パスを定義します。 既定値は、 (通常は $(IntermediateOutputPath)) ディレクトリ内の [プロジェクト名].AssemblyInfo.[cs|vb] という名前のファイルです。

<PropertyGroup>
  <GeneratedAssemblyInfoFile>assemblyinfo.cs</GeneratedAssemblyInfoFile>
</PropertyGroup>

IncludeSourceRevisionInInformationalVersion

IncludeSourceRevisionInInformationalVersion プロパティは、SourceRevisionId値を InformationalVersion アセンブリ属性に追加するかどうかを制御します。 既定値は true です。 この動作を無効にするには、 false に設定します。

<PropertyGroup>
  <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
</PropertyGroup>

詳細については、.NET SDK に含まれる Source Link を参照してください。

SourceRevisionId

SourceRevisionId プロパティは、Git コミット ハッシュなど、ビルドのソース管理リビジョン ID を保持します。 .NET 8 以降では、.NET SDK は、Source Link が存在する場合に、このプロパティにコミット ハッシュを自動的に設定します。 設定すると、その値が InformationalVersion アセンブリ属性に追加されます。

<PropertyGroup>
  <SourceRevisionId>abc1234</SourceRevisionId>
</PropertyGroup>

詳細については、.NET SDK に含まれる Source Link を参照してください。

フレームワークのプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• TargetFramework
• TargetFrameworks
• NetStandardImplicitPackageVersion

TargetFramework

TargetFramework プロパティには、アプリのターゲット フレームワーク バージョンを指定します。 有効なターゲット フレームワーク モニカーの一覧については、「SDK スタイルのプロジェクトでのターゲット フレームワーク」を参照してください。

<PropertyGroup>
  <TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

詳細については、「SDK スタイルのプロジェクトでのターゲット フレームワーク」を参照してください。

TargetFrameworks

アプリで複数のプラットフォームをターゲットにする場合は、TargetFrameworks プロパティを使用します。 有効なターゲット フレームワーク モニカーの一覧については、「SDK スタイルのプロジェクトでのターゲット フレームワーク」を参照してください。

<PropertyGroup>
  <TargetFrameworks>net8.0;net462</TargetFrameworks>
</PropertyGroup>

詳細については、「SDK スタイルのプロジェクトでのターゲット フレームワーク」を参照してください。

NetStandardImplicitPackageVersion

メタパッケージ バージョンよりも低いフレームワーク バージョンを指定する場合は、NetStandardImplicitPackageVersion プロパティを使用します。 次の例のプロジェクト ファイルは、netstandard1.3 をターゲットにしていますが、NETStandard.Library の 1.6.0 バージョンを使用しています。

<PropertyGroup>
  <TargetFramework>netstandard1.3</TargetFramework>
  <NetStandardImplicitPackageVersion>1.6.0</NetStandardImplicitPackageVersion>
</PropertyGroup>

パッケージのプロパティ

• 説明的なプロパティ
• PackRelease

説明的なプロパティ

PackageId、PackageVersion、PackageIcon、Title、Description などのプロパティを指定し、プロジェクトから作成されたパッケージについて説明できます。 以上のプロパティとその他のプロパティの詳細については、「pack ターゲット」を参照してください。

<PropertyGroup>
  ...
  <PackageId>ClassLibDotNetStandard</PackageId>
  <Version>1.0.0</Version>
  <Authors>John Doe</Authors>
  <Company>Contoso</Company>
</PropertyGroup>

PackRelease

この PackRelease プロパティは PublishRelease プロパティに似ていますが、既定の dotnet pack 動作が変更される点が異なります。 このプロパティは、.NET 7 で導入されました。

<PropertyGroup>
  <PackRelease>true</PackRelease>
</PropertyGroup>

パッケージ検証プロパティ

これらのプロパティと項目は、ValidatePackage タスクに渡されます。 パッケージの検証の詳細については、「パッケージ検証の概要」を参照してください。

ValidateAssemblies タスクのプロパティについては、「アセンブリ検証プロパティ」を参照してください。

このセクションでは、次の MSBuild プロパティと項目について説明します。

• ApiCompatEnableRuleAttributesMustMatch
• ApiCompatEnableRuleCannotChangeParameterName
• ApiCompatExcludeAttributesFile
• ApiCompatGenerateSuppressionFile
• ApiCompatPermitUnnecessarySuppressions
• ApiCompatPreserveUnnecessarySuppressions
• ApiCompatRespectInternals
• ApiCompatSuppressionFile
• ApiCompatSuppressionOutputFile
• EnablePackageValidation
• EnableStrictModeForBaselineValidation
• EnableStrictModeForCompatibleFrameworksInPackage
• EnableStrictModeForCompatibleTfms
• NoWarn
• PackageValidationBaselineFrameworkToIgnore
• PackageValidationBaselineName
• PackageValidationBaselineVersion
• PackageValidationReferencePath
• RoslynAssembliesPath

ApiCompatEnableRuleAttributesMustMatch

true に設定すると、ApiCompatEnableRuleAttributesMustMatch プロパティによって、属性が一致するかどうかをチェックする検証規則が有効になります。 既定値は、false です。

<PropertyGroup>
  <ApiCompatEnableRuleAttributesMustMatch>true</ApiCompatEnableRuleAttributesMustMatch>
</PropertyGroup>

ApiCompatEnableRuleCannotChangeParameterName

trueに設定すると、ApiCompatEnableRuleCannotChangeParameterName プロパティにより、パラメーター名がパブリック メソッドで変更されたかどうかを確認する検証規則が有効になります。 既定値は、false です。

<PropertyGroup>
  <ApiCompatEnableRuleCannotChangeParameterName>true</ApiCompatEnableRuleCannotChangeParameterName>
</PropertyGroup>

ApiCompatExcludeAttributesFile

ApiCompatExcludeAttributesFile 項目は、DocId 形式で除外する属性を含むファイルへのパスを指定します。

<ItemGroup>
  <ApiCompatExcludeAttributesFile Include="ApiCompatExcludedAttributes.txt" />
  <ApiCompatExcludeAttributesFile Include="ApiCompatBaselineExcludedAttributes.txt" />
</ItemGroup>

ApiCompatGenerateSuppressionFile

ApiCompatGenerateSuppressionFile プロパティにより、互換性抑制ファイルを生成するかどうかが指定されます。

<PropertyGroup>
  <ApiCompatGenerateSuppressionFile>true</ApiCompatGenerateSuppressionFile>
</PropertyGroup>

ApiCompatPermitUnnecessarySuppressions

ApiCompatPermitUnnecessarySuppressions プロパティにより、抑制ファイルで不要な抑制を許可するかどうかが指定されます。

既定値は、false です。

<PropertyGroup>
  <ApiCompatPermitUnnecessarySuppressions>true</ApiCompatPermitUnnecessarySuppressions>
</PropertyGroup>

ApiCompatPreserveUnnecessarySuppressions

ApiCompatPreserveUnnecessarySuppressions プロパティにより、抑制ファイルを再生成するときに不要な抑制を保持するかどうかが指定されます。 既存の抑制ファイルが再生成されるときは、その内容が読み取られ、一連の抑制に逆シリアル化された後、リストに格納されます。 非互換性が修正されている場合、一部の抑制は不要になる可能性があります。 抑制をディスクにシリアル化し直す場合は、このプロパティを に設定することで、既存の (逆シリアル化された) 式を "すべて" 保持することができます。true

既定値は、false です。

<PropertyGroup>
  <ApiCompatPreserveUnnecessarySuppressions>true</ApiCompatPreserveUnnecessarySuppressions>
</PropertyGroup>

ApiCompatRespectInternals

ApiCompatRespectInternals プロパティにより、internal API に加えて、 public API の互換性を確認する必要があるかどうかが指定されます。

<PropertyGroup>
  <ApiCompatRespectInternals>true</ApiCompatRespectInternals>
</PropertyGroup>

ApiCompatSuppressionFile

ApiCompatSuppressionFile 項目により、読み取る 1 つ以上の抑制ファイルへのパスが指定されます。 指定しない場合、抑制ファイル <project-directory>/CompatibilitySuppressions.xml が読み取られます (存在する場合)。

<ItemGroup>
  <ApiCompatSuppressionFile Include="CompatibilitySuppressions.xml;CompatibilitySuppressions.WasmThreads.xml" />
</ItemGroup>

ApiCompatSuppressionOutputFile

ApiCompatSuppressionOutputFile プロパティにより、<ApiCompatGenerateSuppressionFile> が true の場合に書き込む抑制ファイルへのパスが指定されます。 指定しないと、最初の ApiCompatSuppressionFile 項目が使われます。

EnablePackageValidation

EnablePackageValidation プロパティを使用すると、Pack タスクの後にパッケージの一連の検証が有効になります。 詳細については、パッケージの検証に関する記事を参照してください。

<PropertyGroup>
  <EnablePackageValidation>true</EnablePackageValidation>
</PropertyGroup>

EnableStrictModeForBaselineValidation

trueに設定すると、 EnableStrictModeForBaselineValidation プロパティにより、パッケージのベースライン チェックの厳格モードが有効になります。 既定値は、false です。

EnableStrictModeForCompatibleFrameworksInPackage

true に設定すると、EnableStrictModeForCompatibleFrameworksInPackage プロパティにより、ターゲット フレームワークに基づいて互換性のあるアセンブリの厳格モードが有効になります。 既定値は、false です。

EnableStrictModeForCompatibleTfms

true に設定すると、EnableStrictModeForCompatibleTfms プロパティにより、互換性のあるすべてのターゲット フレームワークのコントラクトおよび実装アセンブリの厳格モードが有効になります。 既定値は、true です。

NoWarn

NoWarn プロパティにより、抑制する診断 ID が指定されます。

<PropertyGroup>
  <NoWarn>$(NoWarn);PKV0001</NoWarn>
</PropertyGroup>

PackageValidationBaselineFrameworkToIgnore

PackageValidationBaselineFrameworkToIgnore 項目により、ベースライン パッケージから無視するターゲット フレームワークが指定されます。 フレームワーク文字列は、ベースライン パッケージ内のフォルダー名と正確に一致する必要があります。

<ItemGroup>
  <PackageValidationBaselineFrameworkToIgnore Include="netcoreapp2.1" />
</ItemGroup>

PackageValidationBaselineName

PackageValidationBaselineName プロパティにより、現在のパッケージを検証するベースライン パッケージの名前が指定されます。 指定しない場合は、PackageId 値が使用されます。

PackageValidationBaselineVersion

PackageValidationBaselineVersion プロパティにより、現在のパッケージを検証するベースライン パッケージのバージョンが指定されます。

PackageValidationReferencePath

PackageValidationReferencePath 項目により、TFM ごとに参照アセンブリが見つかるディレクトリ パスが指定されます。

<ItemGroup>
  <PackageValidationReferencePath Include="path/to/reference-assembly" TargetFramework="net9.0" />
</ItemGroup>

RoslynAssembliesPath

RoslynAssembliesPath プロパティは、Microsoftを含むディレクトリへのパスを指定します。使用する CodeAnalysis アセンブリ。 このプロパティを設定する必要があるのは、SDK のコンパイラより新しいコンパイラでテストする場合のみです。

発行関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• AppendRuntimeIdentifierToOutputPath
• AppendTargetFrameworkToOutputPath
• CopyLocalLockFileAssemblies
• ErrorOnDuplicatePublishOutputFiles
• GenerateRuntimeConfigDevFile
• GenerateRuntimeConfigurationFiles
• GenerateSatelliteAssembliesForCore
• IsPublishable
• PreserveCompilationContext
• PreserveCompilationReferences
• ProduceReferenceAssemblyInOutDir
• PublishDocumentationFile
• PublishDocumentationFiles
• PublishReferencesDocumentationFiles
• PublishReferencesSymbols
• PublishRelease
• PublishRuntimeIdentifier
• PublishSelfContained
• RollForward
• RuntimeFrameworkVersion
• RuntimeIdentifier
• RuntimeIdentifiers
• SatelliteResourceLanguages
• SelfContained
• UseAppHost
• UseNativeLibPrefix

AppendTargetFrameworkToOutputPath

AppendTargetFrameworkToOutputPath プロパティは、ターゲット フレームワーク モニカー (TFM) を出力パス (OutputPath で定義されている) に追加するかどうかを制御します。 .NET SDK により、ターゲット フレームワークが自動的に追加され、存在する場合はランタイム識別子が出力パスに追加されます。 AppendTargetFrameworkToOutputPath を false に設定すると、TFM が出力パスに追加されなくなります。 ただし、出力パスに TFM がないと、複数のビルド成果物が相互に上書きされる可能性があります。

たとえば、.NET 5 アプリの場合、出力パスは次の設定で bin\Debug\net5.0 から bin\Debug に変わります。

<PropertyGroup>
  <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
</PropertyGroup>

AppendRuntimeIdentifierToOutputPath

AppendRuntimeIdentifierToOutputPath プロパティは、ランタイム識別子 (RID) を出力パスに追加するかどうかを制御します。 .NET SDK によってターゲット フレームワークが自動的に追加され、存在する場合はランタイム識別子 (RID) が出力パスに追加されます。 AppendRuntimeIdentifierToOutputPath を false に設定すると、RID が出力パスに追加されなくなります。 (ただし、RID は 引き続き発行パスに追加されます。詳細については、 dotnet/sdk#12114 を参照してください)。

たとえば、.NET 9 アプリと win-x64 の RID の場合、次の設定では出力パスが bin\Debug\net9.0\win-x64 から bin\Debug\net9.0 に変更されます。

<PropertyGroup>
  <AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
</PropertyGroup>

CopyLocalLockFileAssemblies

CopyLocalLockFileAssemblies プロパティは、他のライブラリに依存しているプラグイン プロジェクトにとって便利です。 このプロパティを true に設定すると、推移的な NuGet パッケージの依存関係が出力ディレクトリにコピーされます。 つまり、dotnet build の出力を使用し、任意のコンピューターでプラグインを実行できます。

<PropertyGroup>
  <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>

CopyLocalLockFileAssembliesの既定値は、出力の種類によって異なる場合があります。 たとえば、クラス ライブラリの場合、既定値は false、コンソール アプリケーションの場合、既定値は true。 必要に応じて、このプロパティを明示的に指定して既定値をオーバーライドできます。

ErrorOnDuplicatePublishOutputFiles

ErrorOnDuplicatePublishOutputFiles プロパティは、MSBuild によって発行出力のファイル重複が検出されるが、削除するべきファイルを判断できないとき、SDK によってエラー NETSDK1148 が生成されるかどうかに関係します。 エラーを生成しない場合、ErrorOnDuplicatePublishOutputFiles プロパティを false に設定します。

<PropertyGroup>
  <ErrorOnDuplicatePublishOutputFiles>false</ErrorOnDuplicatePublishOutputFiles>
</PropertyGroup>

このプロパティは、.NET 6 で導入されました。

GenerateRuntimeConfigDevFile

.NET 6 SDK 以降では、[Appname].runtimesettings.dev.json ファイルはコンパイル時に既定で生成されなくなります。 このファイルを生成させる場合、GenerateRuntimeConfigDevFile プロパティを true に設定してください。

<PropertyGroup>
  <GenerateRuntimeConfigDevFile>true</GenerateRuntimeConfigDevFile>
</PropertyGroup>

GenerateRuntimeConfigurationFiles

GenerateRuntimeConfigurationFiles プロパティによって、ランタイム構成オプションを runtimeconfig.template.json ファイルから [appname].runtimeconfig.json ファイルにコピーするかどうかを制御します。 runtimeconfig.json ファイルが必要なアプリの場合 (つまり、その OutputType が Exe である場合)、このプロパティの既定値は true です。

<PropertyGroup>
  <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
</PropertyGroup>

GenerateSatelliteAssembliesForCore

GenerateSatelliteAssembliesForCore プロパティは、.NET Framework プロジェクトでcsc.exe または Al.exe (アセンブリ リンカー) を使用してサテライト アセンブリを生成するかどうかを制御します。 (.NET Core および .NET 5 以上のプロジェクトでは、サテライト アセンブリを生成するために常に csc.exe を使用します)。.NET Framework プロジェクトの場合、サテライト アセンブリは既定で al.exe によって作成されます。 GenerateSatelliteAssembliesForCore プロパティを true に設定すると、代わりに csc.exe によってサテライト アセンブリが作成されます。 csc.exe を使うと、次の状況で有利になる場合があります。

• C# コンパイラの deterministic オプションを使用する必要がある。
• al.exe はパブリック署名をサポートせず、AssemblyInformationalVersionAttribute を適切に処理できないという事実によって制限されている。

<PropertyGroup>
  <GenerateSatelliteAssembliesForCore>true</GenerateSatelliteAssembliesForCore>
</PropertyGroup>

IsPublishable

IsPublishable プロパティを使用すると、Publish ターゲットを実行できます。 このプロパティは、.*proj ファイルと Publish ターゲット (dotnet publish コマンドなど) を使用するプロセスにのみ影響します。 PublishOnly ターゲットを使用するVisual Studioでの発行には影響しません。 既定値は true です。

このプロパティを使用すると、発行する必要があるプロジェクトを自動的に選択できるようになるため、ソリューション ファイルで dotnet publish を実行する場合に便利です。

<PropertyGroup>
  <IsPublishable>false</IsPublishable>
</PropertyGroup>

PreserveCompilationContext

PreserveCompilationContext プロパティを使用すると、ビルド時に使用したのと同じ設定を使用して、ビルドまたは発行されたアプリケーションで実行時により多くのコードをコンパイルできます。 ビルド時に参照されるアセンブリは、出力ディレクトリの ref サブディレクトリにコピーされます。 参照アセンブリの名前は、コンパイラに渡されるオプションと共に、アプリケーションの .deps.json ファイルに格納されます。 この情報は、DependencyContext.CompileLibraries と DependencyContext.CompilationOptions のプロパティを使用して取得できます。

この機能は、ほとんどの場合、Razor ファイルのランタイム コンパイルをサポートするために、MVC ページと Razor ページ ASP.NET Core内部で使用されます。

<PropertyGroup>
  <PreserveCompilationContext>true</PreserveCompilationContext>
</PropertyGroup>

PreserveCompilationReferences

PreserveCompilationReferences プロパティは PreserveCompilationContext プロパティと似ていますが、 .deps.json ファイルではなく、発行ディレクトリに参照アセンブリのみがコピーされる点が異なります。

<PropertyGroup>
  <PreserveCompilationReferences>true</PreserveCompilationReferences>
</PropertyGroup>

詳細については、「Razor SDK」の「プロパティ」を参照してください。

ProduceReferenceAssemblyInOutDir

.NET 5 以前のバージョンでは、参照アセンブリは常に OutDir ディレクトリに書き込まれます。 .NET 6 以降のバージョンでは、ProduceReferenceAssemblyInOutDir プロパティを使用して、参照アセンブリを OutDir ディレクトリに書き込むかどうかを制御できます。 既定値は false で、参照アセンブリは IntermediateOutputPath ディレクトリにのみ書き込まれます。 参照アセンブリを true ディレクトリに書き込むには、値を OutDir に設定します。

<PropertyGroup>
  <ProduceReferenceAssemblyInOutDir>true</ProduceReferenceAssemblyInOutDir>
</PropertyGroup>

詳細については、「中間出力への参照アセンブリの書き込み」を参照してください。

PublishDocumentationFile

このプロパティが true の場合、プロジェクトの XML ドキュメント ファイルが (生成されていれば)、プロジェクトの発行出力に含まれます。 このプロパティでは、既定値が true に設定されます。

PublishDocumentationFiles

このプロパティは、さまざまな種類の XML ドキュメント ファイル (つまり PublishDocumentationFile や PublishReferencesDocumentationFiles) を既定で発行ディレクトリにコピーするかどうかを制御する他のいくつかのプロパティ用の有効化フラグです。 これらのプロパティが未設定で、このプロパティを設定すると、これらのプロパティは既定で true になります。 このプロパティでは、既定値が true に設定されます。

PublishReferencesDocumentationFiles

このプロパティを trueすると、プロジェクトの参照の XML ドキュメント ファイルは、DLL ファイルなどのランタイム資産だけでなく、発行ディレクトリにコピーされます。 このプロパティでは、既定値が true に設定されます。

PublishReferencesSymbols

このプロパティが trueされると、プロジェクトの参照のシンボル ファイル (PDB ファイルとも呼ばれます) は、DLL ファイルなどのランタイム アセットだけでなく、発行ディレクトリにコピーされます。 このプロパティでは、既定値が true に設定されます。

PublishRelease

この PublishRelease プロパティは、既定で dotnet publish 構成の代わりに Release 構成を使用するように Debug に通知します。 このプロパティは、.NET 7 で導入されました。

<PropertyGroup>
  <PublishRelease>true</PublishRelease>
</PropertyGroup>

PublishRuntimeIdentifier

発行操作専用の 1 つの ランタイム識別子 (RID) を指定します。 このプロパティは、.NET 7 で導入されました。 ビルド操作には影響しません。 発行時に、 PublishRuntimeIdentifier セット RuntimeIdentifier。 RuntimeIdentifierをグローバル プロパティとして渡す場合、その値が優先されます。

<PropertyGroup>
  <PublishRuntimeIdentifier>linux-x64</PublishRuntimeIdentifier>
</PropertyGroup>

PublishSelfContained

PublishSelfContained プロパティは、dotnet publishとしてアプリを発行するように に通知します。 このプロパティは、ソリューション レベルで発行する場合など、--self-contained コマンドに 引数を使用できない場合に便利です。 その場合は、PublishSelfContained MSBuild プロパティをプロジェクトまたは Directory.Build.Props ファイルに追加できます。

このプロパティは、.NET 7 で導入されました。 これは、 動詞に固有である点を除いて、publish プロパティに似ています。 PublishSelfContained の代わりに SelfContained を使用することが推奨されます。

<PropertyGroup>
  <PublishSelfContained>true</PublishSelfContained>
</PropertyGroup>

RollForward

RollForward プロパティによって、複数のランタイム バージョンが利用できるときのアプリケーションによるランタイム選択方法が制御されます。 この値は .runtimeconfig.json に rollForward 設定として出力されます。

<PropertyGroup>
  <RollForward>LatestMinor</RollForward>
</PropertyGroup>

RollForward には、次のいずれかの値を選択します。

詳細については、ロールフォワード動作の制御に関するページを参照してください。

RuntimeFrameworkVersion

RuntimeFrameworkVersion プロパティによって、発行時に使用するランタイムのバージョンが指定されます。 ランタイム バージョンを指定する:

<PropertyGroup>
  <RuntimeFrameworkVersion>5.0.7</RuntimeFrameworkVersion>
</PropertyGroup>

フレームワーク依存のアプリケーションを発行するとき、この値によって、必須の "最小" バージョンが指定されます。 自己完結型のアプリケーションを発行するとき、この値によって、必須となる "厳密な" バージョンが指定されます。

RuntimeIdentifier

RuntimeIdentifier プロパティを使用すると、プロジェクトに 1 つのランタイム識別子 (RID) を指定できます。 RID により、自己完結型の展開を発行できます。

<PropertyGroup>
  <RuntimeIdentifier>linux-x64</RuntimeIdentifier>
</PropertyGroup>

RuntimeIdentifiers

RuntimeIdentifiers プロパティには、プロジェクトのランタイム識別子 (RID) のセミコロン区切りリストを指定できます。 複数のランタイムに発行する必要がある場合は、このプロパティを使用します。 RuntimeIdentifiers は、復元時に適切な資産をグラフに確実に含めるために使用されます。

<PropertyGroup>
  <RuntimeIdentifiers>win-x64;osx-x64;linux-x64</RuntimeIdentifiers>
</PropertyGroup>

SatelliteResourceLanguages

SatelliteResourceLanguages プロパティを使用すると、ビルドおよび発行時にサテライト リソース アセンブリを保持する言語を指定できます。 多くの NuGet パッケージには、そのメイン パッケージにローカライズされたリソース サテライト アセンブリが含まれています。 ローカライズされたリソースを必要としない NuGet パッケージを参照するプロジェクトの場合、ローカライズされたアセンブリによってビルドと発行の出力サイズが不必要に大きくなる可能性があります。 プロジェクト ファイルに SatelliteResourceLanguages プロパティを追加することで、指定した言語のローカライズされたアセンブリだけがビルドと発行の出力に含まれます。 たとえば、次のプロジェクト ファイルでは、英語 (米国) とドイツ語 (ドイツ) のリソース サテライト アセンブリだけが保持されます。

<PropertyGroup>
  <SatelliteResourceLanguages>en-US;de-DE</SatelliteResourceLanguages>
</PropertyGroup>

SelfContained

SelfContained プロパティは、dotnet build と dotnet publish に、自己完結型アプリとしてアプリをビルドまたは発行するように通知します。 このプロパティは、ソリューション レベルで発行する場合など、--self-contained コマンドで 引数を使用できない場合に便利です。 その場合は、SelfContained MSBuild プロパティをプロジェクトまたは Directory.Build.Props ファイルに追加できます。

このプロパティは、PublishSelfContained プロパティに似ています。 可能な限り PublishSelfContained の代わりに SelfContained を使用することが推奨されます。

<PropertyGroup>
  <SelfContained>true</SelfContained>
</PropertyGroup>

UseAppHost

UseAppHost プロパティにより、デプロイ用にネイティブ実行可能ファイルを作成するかどうかが制御されます。 自己完結型の配置にはネイティブの実行可能ファイルが必要です。 フレームワークに依存する実行可能ファイルが既定で作成されます。 実行可能ファイルの生成を無効にするには、UseAppHost プロパティを false に設定します。

<PropertyGroup>
  <UseAppHost>false</UseAppHost>
</PropertyGroup>

デプロイの詳細については、「.NET アプリケーションのデプロイ」を参照してください。

UseNativeLibPrefix

UseNativeLibPrefix プロパティは、NativeAOT が Unix プラットフォーム上の実行可能でないネイティブ ライブラリ出力にlib プレフィックスを適用するかどうかを制御します。 既定では、 lib プレフィックスが適用され、共有ライブラリと静的ライブラリ ( libmylib.so、 libmylib.a など) の Unix の名前付け規則に合わせて調整されます。

既定の動作からオプトアウトするには、 UseNativeLibPrefix を false に設定します。

<PropertyGroup>
  <UseNativeLibPrefix>false</UseNativeLibPrefix>
</PropertyGroup>

このプロパティは、.NET 11 で導入されました。 詳細については、「 NativeAOT では Unix 上のネイティブ ライブラリ出力に lib プレフィックスを使用する」を参照してください。

トリミング関連のプロパティ

さまざまな MSBuild プロパティをトリミングの微調整に使用できます。これは、自己完結型の展開から未使用のコードをトリミングする機能です。 これらのオプションの詳細については、「トリミングのオプション」を参照してください。 次の表に、クイック リファレンスを示します。

ビルド関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• ContinuousIntegrationBuild
• CopyDebugSymbolFilesFromPackages
• CopyDocumentationFilesFromPackages
• DisableImplicitFrameworkDefines
• DocumentationFile
• EmbeddedResourceUseDependentUponConvention
• EnablePreviewFeatures
• EnableWindowsTargeting
• GenerateDocumentationFile
• GenerateRequiresPreviewFeaturesAttribute
• OptimizeImplicitlyTriggeredBuild
• DisableRuntimeMarshalling
• BuildWithNetFrameworkHostedCompiler
• RoslynCompilerType

LangVersion や Nullable などの C# コンパイラ オプションは、プロジェクト ファイルの MSBuild プロパティとして指定することもできます。 詳細については、「C# コンパイラ オプション」を参照してください。

ContinuousIntegrationBuild

ContinuousIntegrationBuild プロパティは、ビルドが継続的インテグレーション (CI) サーバー上で実行されているかどうかを示します。 true に設定すると、このプロパティによって、開発者用マシン上のローカル ビルドではなく、公式ビルドにのみ適用される設定が有効になります。 たとえば、格納されたファイルのパスは公式ビルド用に正規化されます。 ただし、ローカル開発マシンでは、ファイル パスが正規化されている場合、デバッガーはローカル ソース ファイルを見つけることができません。

CI システムの変数を使って、ContinuousIntegrationBuild プロパティを条件付きで設定することができます。 たとえば、Azure Pipelinesの変数名は TF_BUILD です。

<PropertyGroup Condition="'$(TF_BUILD)' == 'true'">
  <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
</PropertyGroup>

GitHub Actionsの場合、変数名は GITHUB_ACTIONS です。

<PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
  <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
</PropertyGroup>

CopyDebugSymbolFilesFromPackages

このプロパティを true に設定すると、プロジェクト内の PackageReference 項目のすべてのシンボル ファイル (PDB ファイルとも呼ばれる) がビルド出力にコピーされます。 これらのファイルは、例外に関するより有益な情報を含むスタック トレースを提供し、実行中のアプリケーションのメモリ ダンプとトレースを理解しやすくします。 ただし、これらのファイルを含めると、デプロイ バンドルのサイズが大きくなります。

このプロパティは .NET SDK 7.0.100 で導入されましたが、既定では指定されていません。

CopyDocumentationFilesFromPackages

このプロパティを true に設定すると、プロジェクト内の PackageReference 項目のすべての生成された XML ドキュメント ファイルがビルド出力にコピーされます。 この機能を有効にすると、デプロイ バンドルのサイズが大きくなることに注意してください。

このプロパティは .NET SDK 7.0.100 で導入されましたが、既定では指定されていません。

DisableImplicitFrameworkDefines

DisableImplicitFrameworkDefines プロパティは、SDK が.NET プロジェクトのターゲット フレームワークとプラットフォームのプリプロセッサ シンボルを生成するかどうかを制御します。 このプロパティは false に設定されているか、設定されていない (既定値) ときは、次のプリプロセッサ シンボルが生成されます。

• バージョンのないフレームワーク (NETFRAMEWORK、NETSTANDARD、NET)
• バージョンのあるフレームワーク (NET48、NETSTANDARD2_0、NET6_0)
• バージョンが最小バインドのフレームワーク (NET48_OR_GREATER、NETSTANDARD2_0_OR_GREATER、NET6_0_OR_GREATER)

ターゲット フレームワーク モニカーとそれらのプリプロセッサ シンボルの詳細については、ターゲット フレームワークに関するページを参照してください。

また、プロジェクトでオペレーティング システム固有のターゲット フレームワーク (たとえば net6.0-android) を指定する場合、次のプリプロセッサ シンボルが生成されます。

• バージョンのないプラットフォーム (ANDROID、IOS、WINDOWS)
• バージョンのあるプラットフォーム (IOS15_1)
• バージョンが最小バインドのプラットフォーム (IOS15_1_OR_GREATER)

オペレーティング システム固有のターゲット フレームワーク モニカーの詳細については、OS 固有の TFM に関するセクションを参照してください。

最後に、ターゲット フレームワークが前のターゲット フレームワークのサポートを意味する場合は、それらの前のフレームワークのプリプロセッサ シンボルが生成されます。 たとえば、net6.0net5.0のサポートなど、.netcoreapp1.0に戻ります。 そのため、これらの各ターゲット フレームワークについて "バージョンが最小限にバインドされているフレームワーク" のシンボルが定義されます。

DocumentationFile

DocumentationFile プロパティを使用すると、そのライブラリのドキュメントが含まれる XML ファイルのファイル名を指定できます。 IntelliSense がドキュメントで正しく機能するには、ファイル名がアセンブリ名と同じである必要があり、アセンブリと同じディレクトリにある必要があります。 このプロパティを指定せず、GenerateDocumentationFile を true に設定すると、そのドキュメント ファイルの名前は既定でアセンブリの名前になりますが、ファイル拡張子は .xml になります。 このため、多くの場合はこのプロパティを省略し、代わりに GenerateDocumentationFile プロパティを使用する方が簡単です。

このプロパティを指定しても、GenerateDocumentationFile を false に設定した場合は、そのコンパイラでドキュメント ファイルは生成 されません。 このプロパティを指定し、GenerateDocumentationFile プロパティを省略した場合は、そのコンパイラでドキュメント ファイルが生成 されます。

<PropertyGroup>
  <DocumentationFile>path/to/file.xml</DocumentationFile>
</PropertyGroup>

EmbeddedResourceUseDependentUponConvention

EmbeddedResourceUseDependentUponConvention プロパティによって、リソース マニフェスト ファイル名が、リソース ファイルと併置されているソース ファイルの型情報から生成されるかどうかを定義します。 たとえば、Form1.vb が Form1.cs と同じフォルダーにあり、EmbeddedResourceUseDependentUponConvention が true に設定されている場合、生成された .resources ファイルは Form1.cs で定義されている最初の型から名前を受け取ります。 MyNamespace.Form1 が Form1.cs で定義されている最初の型である場合、生成されるファイル名は MyNamespace.Form1.resources になります。

既定では、.NET Core 3.0 以降のバージョンを対象とする新しい.NET プロジェクトでは、このプロパティは true に設定されます。 false に設定され、かつプロジェクト ファイルの LogicalName 項目に ManifestResourceName、DependentUpon、EmbeddedResource のメタデータがどれも指定されていない場合、リソース マニフェストのファイル名は、プロジェクトのルート名前空間と、 .resx ファイルへの相対ファイル パスがベースになります。 詳細については、「リソース マニフェスト ファイルの名前付けの方法」を参照してください。

<PropertyGroup>
  <EmbeddedResourceUseDependentUponConvention>true</EmbeddedResourceUseDependentUponConvention>
</PropertyGroup>

EnablePreviewFeatures

EnablePreviewFeatures プロパティによって、RequiresPreviewFeaturesAttribute 属性で修飾されている API またはアセンブリにプロジェクトが依存するかどうかを定義します。 この属性は、API またはアセンブリによって、使用している SDK バージョンの "プレビュー段階" と見なされる機能が使われることを示す場合に使用されます。 プレビュー機能はサポートされておらず、将来のバージョンで削除される可能性があります。 プレビュー機能の使用を有効にするには、このプロパティを True に設定します。

<PropertyGroup>
  <EnablePreviewFeatures>True</EnablePreviewFeatures>
</PropertyGroup>

True に設定されたこのプロパティがプロジェクトに含まれている場合、AssemblyInfo.cs ファイルに次のアセンブリ レベルの属性が追加されます。

[assembly: RequiresPreviewFeatures]

EnablePreviewFeatures が True に設定されていないプロジェクトの依存関係にこの属性が存在する場合、アナライザーによって警告が表示されます。

プレビュー アセンブリをリリースする予定のライブラリ作成者は、このプロパティを True に設定する必要があります。 プレビューと非プレビューの API を組み合わせてアセンブリと共に出荷する必要がある場合は、以下の「GenerateRequiresPreviewFeaturesAttribute」セクションを参照してください。

EnableWindowsTargeting

EnableWindowsTargeting プロパティを true に設定して、Windows以外のプラットフォームでWindows アプリ (Windows フォーム アプリやWindows Presentation Foundation アプリなど) をビルドします。 このプロパティを true に設定しないと、ビルド警告 NETSDK1100 が表示されます。 このエラーは、ターゲット パックやランタイム パックが、サポートされていないプラットフォームで自動的にダウンロードされていないことが原因で発生します。 このプロパティを設定すると、これらのパックはクロスターゲット時にダウンロードされます。

<PropertyGroup>
  <EnableWindowsTargeting>true</EnableWindowsTargeting>
</PropertyGroup>

GenerateDocumentationFile

GenerateDocumentationFile プロパティは、コンパイラでそのライブラリの XML ドキュメント ファイルが生成されるかどうかを制御します。 このプロパティを true に設定し、DocumentationFile プロパティを使用してファイル名を指定しなかった場合、生成された XML ファイルはアセンブリと同じ出力ディレクトリに配置され、同じファイル名になります (ただし、拡張子は .xml になります)。

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

コード コメントからドキュメントを生成する方法の詳細については、 XML ドキュメント コメント (C#)、 XML (Visual Basic)、または XML (F#) でコードをドキュメント化する方法を参照してください。

GenerateRequiresPreviewFeaturesAttribute

GenerateRequiresPreviewFeaturesAttribute プロパティは、EnablePreviewFeatures プロパティと密接に関連しています。 ライブラリでプレビュー機能を使用しているが、アセンブリ全体を RequiresPreviewFeaturesAttribute 属性でマークしたくない場合 (すべてのコンシューマーがプレビュー機能を有効にする必要があります) は、このプロパティを False に設定します。

<PropertyGroup>
    <EnablePreviewFeatures>True</EnablePreviewFeatures>
    <GenerateRequiresPreviewFeaturesAttribute>False</GenerateRequiresPreviewFeaturesAttribute>
</PropertyGroup>

OptimizeImplicitlyTriggeredBuild

ビルド時間を短縮するために、null 許容分析を含むコード分析をスキップVisual Studioによって暗黙的にトリガーされるビルド。 Visual Studioは、たとえば、テストの実行時に暗黙的なビルドをトリガーします。 ただし、暗黙的なビルドは、TreatWarningsAsErrors が true ではない場合にのみ最適化されます。 TreatWarningsAsErrors を true に設定したが、暗黙的にトリガーされるビルドを引き続き最適化したい場合は、OptimizeImplicitlyTriggeredBuild を True に設定できます。 暗黙的にトリガーされるビルドに対してビルドの最適化を無効にする場合は、OptimizeImplicitlyTriggeredBuild を False に設定します。

<PropertyGroup>
    <OptimizeImplicitlyTriggeredBuild>True</OptimizeImplicitlyTriggeredBuild>
</PropertyGroup>

DisableRuntimeMarshalling

DisableRuntimeMarshalling プロパティを指定すると、プロジェクトのランタイム マーシャリング サポートを無効にすることができます。 このプロパティを true に設定すると、DisableRuntimeMarshallingAttribute がアセンブリに追加され、P/Invoke またはデリゲート ベースの相互運用機能は、無効になっているランタイム マーシャリングの規則に従います。

<PropertyGroup>
    <DisableRuntimeMarshalling>True</DisableRuntimeMarshalling>
</PropertyGroup>

BuildWithNetFrameworkHostedCompiler

BuildWithNetFrameworkHostedCompiler=trueの指定は、RoslynCompilerType=FrameworkPackageを指定することと同じです。 詳細については、「 RoslynCompilerType」を参照してください。 BuildWithNetFrameworkHostedCompiler=falseを指定すると、RoslynCompilerType=FrameworkPackageへの自動オプトインが行われないようにします。 RoslynCompilerTypeを明示的に指定した場合、BuildWithNetFrameworkHostedCompilerは効果がありません。

RoslynCompilerType

RoslynCompilerType プロパティは、C# または Visual Basic コンパイラのバージョンを制御します。 次の値が認識されます。

• Core: .NET SDK に付属するコンパイラを使用します。 これは、.NET Framework MSBuild を使用する場合でも、.NET 10 であるための既定値です。
• Framework: .NET Framework MSBuild に付属するコンパイラを使用します。
• FrameworkPackage: .NET Framework MSBuild を使用する場合は、.NET SDK バージョンに対応する .NET Framework コンパイラでパッケージをダウンロードして使用します。

既定の項目の包含プロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• DefaultItemExcludesInProjectFolder
• DefaultItemExcludes
• EnableDefaultCompileItems
• EnableDefaultEmbeddedResourceItems
• EnableDefaultItems
• EnableDefaultNoneItems

詳細については、「既定で含まれるものと除外されるもの」を参照してください。

DefaultItemExcludes

DefaultItemExcludes プロパティを使用して、含まれる、除外される、および削除の glob から除外するファイルとフォルダーの glob パターンを定義します。 既定では、 ./bin および ./obj フォルダーは、glob パターンから除外されます。

<PropertyGroup>
  <DefaultItemExcludes>$(DefaultItemExcludes);**/*.myextension</DefaultItemExcludes>
</PropertyGroup>

DefaultItemExcludesInProjectFolder

DefaultItemExcludesInProjectFolder プロパティを使用して、含まれる、除外される、および削除の glob から除外する、プロジェクト フォルダーのファイルとフォルダーの glob パターンを定義します。 既定では、ピリオド (.) で始まるフォルダー ( .git や .vs など) は、glob パターンから除外されます。

このプロパティは、プロジェクト フォルダー内のファイルとフォルダーのみが考慮される点を除いて、DefaultItemExcludes プロパティとよく似ています。 glob パターンが意図せずにプロジェクト フォルダー外の項目と相対パスを照合する場合は、DefaultItemExcludesInProjectFolder プロパティの代わりに DefaultItemExcludes プロパティを使用します。

<PropertyGroup>
  <DefaultItemExcludesInProjectFolder>$(DefaultItemExcludesInProjectFolder);**/myprefix*/**</DefaultItemExcludesInProjectFolder>
</PropertyGroup>

EnableDefaultItems

EnableDefaultItems プロパティは、コンパイル項目、埋め込みリソース項目、および None 項目がプロジェクトに暗黙的に含まれるかどうかを制御します。 既定値は true です。 EnableDefaultItems プロパティを false に設定して、暗黙的なファイルの組み込みをすべて無効にします。

<PropertyGroup>
  <EnableDefaultItems>false</EnableDefaultItems>
</PropertyGroup>

EnableDefaultCompileItems

EnableDefaultCompileItems プロパティは、コンパイル項目がプロジェクトに暗黙的に含まれるかどうかを制御します。 既定値は true です。 EnableDefaultCompileItems プロパティを false に設定して、*.cs およびその他の言語拡張ファイルの暗黙的な包含を無効にします。

<PropertyGroup>
  <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
</PropertyGroup>

EnableDefaultEmbeddedResourceItems

EnableDefaultEmbeddedResourceItems プロパティは、埋め込みリソース項目がプロジェクトに暗黙的に含まれるかどうかを制御します。 既定値は true です。 埋め込みリソース ファイルの暗黙的な包含を無効にするには、EnableDefaultEmbeddedResourceItems プロパティを false に設定します。

<PropertyGroup>
  <EnableDefaultEmbeddedResourceItems>false</EnableDefaultEmbeddedResourceItems>
</PropertyGroup>

EnableDefaultNoneItems

EnableDefaultNoneItems プロパティは、None 項目 (ビルド プロセスでロールがないファイル) がプロジェクトに暗黙的に含まれるかどうかを制御します。 既定値は true です。 EnableDefaultNoneItems プロパティを false に設定して、None 項目の暗黙的な包含を無効にします。

<PropertyGroup>
  <EnableDefaultNoneItems>false</EnableDefaultNoneItems>
</PropertyGroup>

コード分析のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• AnalysisLevel
• 分析レベル<カテゴリ>
• AnalysisMode
• AnalysisMode<カテゴリ>
• CodeAnalysisTreatWarningsAsErrors
• EnableNETAnalyzers
• EnforceCodeStyleInBuild
• _SkipUpgradeNetAnalyzersNuGetWarning

AnalysisLevel

AnalysisLevel プロパティを使用すると、.NET リリースに従って実行するコード アナライザーのセットを指定できます。 各.NETリリースには、一連のコード分析ルールがあります。 そのセットのうち、そのリリースで既定で有効になっているルールによって、コードが分析されます。 たとえば、.NET 8 から .NET 9 にアップグレードしても、コード分析規則の既定のセットを変更したくない場合は、AnalysisLevel を 8 に設定します。

<PropertyGroup>
  <AnalysisLevel>8</AnalysisLevel>
</PropertyGroup>

必要に応じて、このプロパティの複合値を指定して、ルールを有効にするアグレッシブな方法を指定することもできます。 複合値は、<version>-<mode> という形式になります。ここで、<mode> 値は、AnalysisMode 値の 1 つです。 次の例では、コード アナライザーの preview バージョンを使用し、 recommended ルールのセットを有効にします。

<PropertyGroup>
  <AnalysisLevel>preview-recommended</AnalysisLevel>
</PropertyGroup>

既定値：

• プロジェクト.NET 5 以降を対象とする場合、または AnalysisMode プロパティを追加した場合、既定値は latest です。
• それ以外の場合、このプロパティは、プロジェクト ファイルに明示的に追加されていない限り省略されます。

次の表は、指定できる値を示しています。

AnalysisLevel<カテゴリ>

このプロパティは、コード分析規則の特定のカテゴリにのみ適用される点を除いて、AnalysisLevel と同じです。 このプロパティを使用すると、特定のカテゴリに対して異なるバージョンのコード アナライザーを使用したり、他の規則カテゴリに対して異なるレベルの規則を有効または無効にしたりできます。 特定の規則カテゴリに対してこのプロパティを省略した場合、既定で AnalysisLevel 値に設定されます。 使用可能な値は、AnalysisLevel に使用できるものと同じです。

<PropertyGroup>
  <AnalysisLevelSecurity>preview</AnalysisLevelSecurity>
</PropertyGroup>

<PropertyGroup>
  <AnalysisLevelSecurity>preview-recommended</AnalysisLevelSecurity>
</PropertyGroup>

次の表は、各規則カテゴリのプロパティ名を示しています。

AnalysisMode

.NET SDK には、すべての "CA" コード品質規則が付属しています。 既定では、一部のルールのみが有効になります各.NETリリースでビルド警告として有効になります。 AnalysisMode プロパティを使うと、既定で有効になる規則のセットをカスタマイズできます。 より積極的な分析モード (ルールを個々にオプトアウトできる)、またはより保守的な分析モード (特定のルールにオプトインできる) に切り替えることができます。 たとえば、すべてのルールをビルド警告として有効にする場合は、値を All に設定します。

<PropertyGroup>
  <AnalysisMode>All</AnalysisMode>
</PropertyGroup>

次の表で利用可能なオプションの値について説明します。 これらは、有効になる規則の数に従って昇順に一覧表示されています。

AnalysisMode<カテゴリ>

このプロパティは、コード分析規則の特定のカテゴリにのみ適用される点を除いて、AnalysisMode と同じです。 このプロパティを使用すると、他の規則カテゴリとは異なるレベルで規則を有効または無効にすることができます。 特定の規則カテゴリに対してこのプロパティを省略した場合、既定で AnalysisMode 値に設定されます。 使用可能な値は、AnalysisMode に使用できるものと同じです。

<PropertyGroup>
  <AnalysisModeSecurity>All</AnalysisModeSecurity>
</PropertyGroup>

次の表は、各規則カテゴリのプロパティ名を示しています。

CodeAnalysisTreatWarningsAsErrors

CodeAnalysisTreatWarningsAsErrors プロパティを使用すると、コード品質分析の警告 (CAxxxx) を警告として扱い、ビルドを中断するかどうかを構成できます。 プロジェクトのビルド時に -warnaserror フラグを使用すると、.NET コード品質分析警告もエラーとして扱われます。 コード品質分析の警告がエラーとして扱われないようにするには、プロジェクト ファイル内の CodeAnalysisTreatWarningsAsErrors MSBuild プロパティを false に設定します。

<PropertyGroup>
  <CodeAnalysisTreatWarningsAsErrors>false</CodeAnalysisTreatWarningsAsErrors>
</PropertyGroup>

EnableNETAnalyzers

.NETコード品質分析 は、5 以降のバージョン.NET対象のプロジェクトに対して既定で有効になっています。 .NET 5 以降の SDK を使用して開発している場合は、EnableNETAnalyzers プロパティを true に設定することで、以前のバージョンの.NETを対象とする SDK スタイルのプロジェクトの.NET コード分析を有効にすることができます。 任意のプロジェクトでコード分析を無効にするには、このプロパティを false に設定します。

<PropertyGroup>
  <EnableNETAnalyzers>true</EnableNETAnalyzers>
</PropertyGroup>

EnforceCodeStyleInBuild

.NETコード スタイル分析は、すべての.NET プロジェクトのビルド時に既定で無効になっています。 EnforceCodeStyleInBuild プロパティを true に設定することで、.NET プロジェクトのコード スタイル分析を有効にすることができます。 (ただし、パフォーマンス上の理由から、Visual Studio IDEでのみ適用されるコード スタイルの規則の一部は実行されません)。

<PropertyGroup>
  <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
</PropertyGroup>

警告またはエラーになるように構成されているすべてのコード スタイル ルールは、ビルド時に実行され、違反を報告します。

_SkipUpgradeNetAnalyzersNuGetWarning

_SkipUpgradeNetAnalyzersNuGetWarning プロパティを使用すると、最新の .NET SDK のコード アナライザーと比較して古い NuGet パッケージのコード アナライザーを使用している場合に警告を受け取るかどうかを構成できます。 警告は次のように表示されます。

.NET SDK には、'Microsoft' のバージョン '5.0.3' よりもバージョン '6.0.0' の新しいアナライザーがあります。CodeAnalysis.NetAnalyzers のパッケージが提供します。 Update or remove this package reference. (このパッケージ参照を更新または削除してください。)

この警告を削除して、NuGet パッケージのコード アナライザーのバージョンの使用を続けるには、プロジェクト ファイルで、_SkipUpgradeNetAnalyzersNuGetWarning を true に設定します。

<PropertyGroup>
  <_SkipUpgradeNetAnalyzersNuGetWarning>true</_SkipUpgradeNetAnalyzersNuGetWarning>
</PropertyGroup>

ランタイム構成プロパティ

アプリのプロジェクト ファイルに MSBuild プロパティを指定することで一部のランタイム動作を構成できます。 ランタイム動作のその他の構成方法については、ランタイム構成設定に関する記事をご覧ください。

• AutoreleasePoolSupport
• ConcurrentGarbageCollection
• InvariantGlobalization
• PredefinedCulturesOnly
• RetainVMGarbageCollection
• ServerGarbageCollection
• ThreadPoolMaxThreads
• ThreadPoolMinThreads
• TieredCompilation
• TieredCompilationQuickJit
• TieredCompilationQuickJitForLoops
• TieredPGO
• UseWindowsThreadPool

AutoreleasePoolSupport

AutoreleasePoolSupport プロパティは、サポートされている macOS プラットフォームで実行されたときに、各マネージド スレッドが暗黙的な NSAutoreleasePool を受け取るかどうかを構成します。 詳細については、「マネージド スレッドでの AutoreleasePool」を参照してください。

<PropertyGroup>
  <AutoreleasePoolSupport>true</AutoreleasePoolSupport>
</PropertyGroup>

ConcurrentGarbageCollection

ConcurrentGarbageCollection プロパティでは、バックグラウンド (同時実行) ガベージ コレクションの有効または無効が設定されます。 この値を false に設定すると、バックグラウンド ガベージ コレクションが無効になります。 詳細については、「バックグラウンド GC」を参照してください。

<PropertyGroup>
  <ConcurrentGarbageCollection>false</ConcurrentGarbageCollection>
</PropertyGroup>

InvariantGlobalization

InvariantGlobalization プロパティでは、アプリを globalization-invariant モードで実行するかどうかを設定します。このモードでは、カルチャ固有のデータにアクセスできません。 この値を true に設定すると、globalization-invariant モードで実行されます。 詳細については、「インバリアント モード」を参照してください。

<PropertyGroup>
  <InvariantGlobalization>true</InvariantGlobalization>
</PropertyGroup>

PredefinedCulturesOnly

.NET 6 以降のバージョンでは、PredefinedCulturesOnly プロパティは、globalization-invariant mode が有効な場合に、アプリがインバリアント カルチャ以外のカルチャを作成できるかどうかを構成します。 既定値は、true です。 グローバリゼーション インバリアント モードで新しいカルチャの作成を許可するには、値を false に設定します。

<PropertyGroup>
  <PredefinedCulturesOnly>false</PredefinedCulturesOnly>
</PropertyGroup>

詳細については、「グローバリゼーション インバリアント モードでのカルチャの作成とケース マッピング」を参照してください。

RetainVMGarbageCollection

RetainVMGarbageCollection プロパティでは、将来利用する目的で削除済みメモリ セグメントを待機一覧に載せるように、あるいは削除済みメモリ セグメントを解放するようにガベージ コレクターを設定します。 この値を true に設定すると、セグメントを待機一覧に載せるよう、ガベージ コレクターが命令されます。 詳細については、「VM の保持」を参照してください。

<PropertyGroup>
  <RetainVMGarbageCollection>true</RetainVMGarbageCollection>
</PropertyGroup>

ServerGarbageCollection

ServerGarbageCollection プロパティでは、アプリケーションで使用するガベージ コレクションとしてワークステーション ガベージ コレクションまたはサーバー ガベージ コレクションを設定します。 この値を true に設定すると、サーバー ガベージ コレクションが使用されます。 詳細については、「ワークステーションとサーバー」を参照してください。

<PropertyGroup>
  <ServerGarbageCollection>true</ServerGarbageCollection>
</PropertyGroup>

ThreadPoolMaxThreads

ThreadPoolMaxThreads プロパティでは、ワーカー スレッド プールの最大スレッド数を設定します。 詳細については、「最大スレッド数」を参照してください。

<PropertyGroup>
  <ThreadPoolMaxThreads>20</ThreadPoolMaxThreads>
</PropertyGroup>

ThreadPoolMinThreads

ThreadPoolMinThreads プロパティでは、ワーカー スレッド プールの最小スレッド数を設定します。 詳細については、「最小スレッド数」を参照してください。

<PropertyGroup>
  <ThreadPoolMinThreads>4</ThreadPoolMinThreads>
</PropertyGroup>

TieredCompilation

TieredCompilation プロパティでは、Just-In-Time (JIT) コンパイラで階層型コンパイルを使用するかどうかを設定します。 この値を false に設定すると、階層型コンパイルが無効になります。 詳細については、「階層型コンパイル」を参照してください。

<PropertyGroup>
  <TieredCompilation>false</TieredCompilation>
</PropertyGroup>

TieredCompilationQuickJit

TieredCompilationQuickJit プロパティでは、JIT コンパイラでクイック JIT を使用するかどうかを設定します。 この値を false に設定すると、クイック JIT が無効になります。 詳細については、「クイック JIT」を参照してください。

<PropertyGroup>
  <TieredCompilationQuickJit>false</TieredCompilationQuickJit>
</PropertyGroup>

TieredCompilationQuickJitForLoops

TieredCompilationQuickJitForLoops プロパティでは、ループを含むメソッドに対して JIT コンパイラでクリック JIT を使用するかどうかを設定します。 この値を true に設定すると、ループが含まれるメソッドでクイック JIT が有効になります。 詳細については、「ループに対するクイック JIT」を参照してください。

<PropertyGroup>
  <TieredCompilationQuickJitForLoops>true</TieredCompilationQuickJitForLoops>
</PropertyGroup>

TieredPGO

TieredPGO プロパティは、動的または階層化されたガイド付き最適化のプロファイル (PGO) を有効にするかどうかを制御します。 この値を true に設定すると、階層化された PGO が有効になります。 詳細については、「ガイド付き最適化のプロファイル」を参照してください。

<PropertyGroup>
  <TieredPGO>true</TieredPGO>
</PropertyGroup>

UseWindowsThreadPool

UseWindowsThreadPool プロパティは、スレッド プールのスレッド管理をWindowsスレッド プールに委任するかどうかを構成します (Windowsのみ)。 既定値は false です。この場合、.NET スレッド プールが使用されます。 詳細については、「Windows スレッド プールを参照してください。

<PropertyGroup>
  <UseWindowsThreadPool>true</UseWindowsThreadPool>
</PropertyGroup>

参照関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• AssetTargetFallback
• DisableImplicitFrameworkReferences
• DisableTransitiveFrameworkReferenceDownloads
• DisableTransitiveProjectReferences
• ManagePackageVersionsCentrally
• 復元関連のプロパティ
• UseMauiEssentials
• ValidateExecutableReferencesMatchSelfContained

AssetTargetFallback

AssetTargetFallback プロパティを使用すると、プロジェクト参照と NuGet パッケージに対して、互換性のある追加のフレームワーク バージョンを指定できます。 たとえば、PackageReference を使用してパッケージの依存関係を指定し、そのパッケージにプロジェクトの TargetFramework と互換性のある資産が含まれない場合は、AssetTargetFallback プロパティが機能します。 参照されたパッケージの互換性は、AssetTargetFallback で指定された各ターゲット フレームワークを使用して再確認されます。 このプロパティは、非推奨のプロパティ PackageTargetFallback に代わるものです。

AssetTargetFallback プロパティを 1 つ以上のターゲット フレームワーク バージョンに設定できます。

<PropertyGroup>
  <AssetTargetFallback>net461</AssetTargetFallback>
</PropertyGroup>

DisableImplicitFrameworkReferences

DisableImplicitFrameworkReferences プロパティは、Core 3.0 以降のバージョン.NET対象とする場合、暗黙的な FrameworkReference 項目を制御します。 Core 2.1 以前のバージョン.NET Core 2.1 または .NET Standard 2.0 以前のバージョンを対象とする場合、メタパッケージ内のパッケージに対して暗黙的な PackageReference 項目を制御します。 (メタパッケージは、他のパッケージへの依存関係のみで構成されるフレームワーク ベースのパッケージです)。また、このプロパティは、System や System.Core などの暗黙的な参照.NET Framework を対象とするときに制御します。

このプロパティを true に設定すると、暗黙的な FrameworkReference または PackageReference の項目が無効になります。 このプロパティを true に設定すると、必要なフレームワークまたはパッケージだけに明示的な参照を追加できます。

<PropertyGroup>
  <DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>
</PropertyGroup>

DisableTransitiveFrameworkReferenceDownloads

DisableTransitiveFrameworkReferenceDownloads プロパティを true に設定して、プロジェクトによって直接参照されていない追加のランタイム パックやターゲット パックがダウンロードされないようにします。

<PropertyGroup>
  <DisableTransitiveFrameworkReferenceDownloads>true</DisableTransitiveFrameworkReferenceDownloads>
</PropertyGroup>

DisableTransitiveProjectReferences

DisableTransitiveProjectReferences プロパティにより、暗黙的なプロジェクト参照を制御できます。 暗黙的な true の項目を無効にするには、このプロパティを ProjectReference に設定します。 暗黙的なプロジェクト参照を無効にすると、レガシ プロジェクト システムに似た非推移的な動作になります。

このプロパティを true にすると、依存しているプロジェクトのすべての依存関係に対して PrivateAssets="All" を設定するのと同様の効果があります。

このプロパティを true に設定すると、必要なプロジェクトだけに明示的な参照を追加できます。

<PropertyGroup>
  <DisableTransitiveProjectReferences>true</DisableTransitiveProjectReferences>
</PropertyGroup>

ManagePackageVersionsCentrally

ManagePackageVersionsCentrally プロパティは、.NET 7 で導入されました。 リポジトリのルートにある true ファイルでこれを に設定すると、プロジェクト内の共通の依存関係を 1 か所で管理できます。 PackageVersion ファイルの の項目を使って、共通のパッケージ依存関係のバージョンを追加します。 こうすると、個々のプロジェクト ファイルでは、一元管理されているパッケージを参照する Version 項目から PackageReference 属性を省略できるようになります。

Directory.Packages.props ファイルの例:

<PropertyGroup>
  <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
...
<ItemGroup>
  <PackageVersion Include="Microsoft.Extensions.Configuration" Version="9.0.0" />
</ItemGroup>

個々のプロジェクト ファイル:

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Configuration" />
</ItemGroup>

詳細については、中央パッケージ管理 (CPM) に関する記事を参照してください。

復元関連のプロパティ

参照されたパッケージを復元すると、その直接的な依存関係と間接的な依存関係がすべてインストールされます。 RestorePackagesPath や RestoreIgnoreFailedSources など、プロパティを指定することでパッケージ復元をカスタマイズできます。 以上のプロパティとその他のプロパティの詳細については、「restore ターゲット」を参照してください。

<PropertyGroup>
  <RestoreIgnoreFailedSource>true</RestoreIgnoreFailedSource>
</PropertyGroup>

UseMauiEssentials

UseMauiEssentials プロパティを true に設定して、MAUI Essentials に依存するプロジェクトまたはパッケージに明示的な参照を宣言します。 この設定により、MAUI Essentials の正しい既知のフレームワーク参照でプロジェクトが確実にプルされます。 プロジェクトが MAUI Essentials を使用するプロジェクトを参照しているが、このプロパティを true に設定しない場合、ビルド警告 NETSDK1186 が発生する可能性があります。

<PropertyGroup>
  <UseMauiEssentials>true</UseMauiEssentials>
</PropertyGroup>

ValidateExecutableReferencesMatchSelfContained

ValidateExecutableReferencesMatchSelfContained プロパティを使用して、実行可能なプロジェクト参照に関連するエラーを無効にできます。 自己完結型の実行可能プロジェクトがフレームワーク依存の実行可能プロジェクトを参照していることを検出.NET、またはその逆の場合は、エラー NETSDK1150とNETSDK1151が生成されます。 参照が意図的なものである場合にこのエラーを回避するには、ValidateExecutableReferencesMatchSelfContained プロパティを false に設定します。

<PropertyGroup>
  <ValidateExecutableReferencesMatchSelfContained>false</ValidateExecutableReferencesMatchSelfContained>
</PropertyGroup>

WindowsSdkPackageVersion

WindowsSdkPackageVersion プロパティを使用して、Windows SDK ターゲット パッケージのバージョンをオーバーライドできます。 このプロパティは、.NET 5 で導入され、この目的で FrameworkReference 項目の使用を置き換えます。

<PropertyGroup>
  <WindowsSdkPackageVersion>10.0.19041.18</WindowsSdkPackageVersion>
</PropertyGroup>

実行関連のプロパティ

次のプロパティは、dotnet run コマンドを使用してアプリを起動するために使用されます。

• RunArguments
• RunWorkingDirectory

RunArguments

RunArguments プロパティは、実行時にアプリに渡される引数を定義します。

<PropertyGroup>
  <RunArguments>-mode dryrun</RunArguments>
</PropertyGroup>

RunWorkingDirectory

RunWorkingDirectory プロパティを使用すると、開始するアプリケーション プロセスの作業ディレクトリが定義されます。 絶対パスまたはプロジェクト ディレクトリに対する相対パスを指定できます。 ディレクトリを指定しない場合、作業ディレクトリとして OutDir が使用されます。

<PropertyGroup>
  <RunWorkingDirectory>c:\temp</RunWorkingDirectory>
</PropertyGroup>

SDK 関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• SdkAnalysisLevel

SdkAnalysisLevel

.NET 9 で導入された SdkAnalysisLevel プロパティを使用して、sdk ツールのstrictを構成できます。 GLOBAL.JSONまたはその他の方法で SDK をピン留めできない場合に、SDK の警告レベルを管理するのに役立ちます。 このプロパティを使用すると、古い SDK をインストールしなくても、特定のツールや機能に関して古い SDK のように動作するように新しい SDK に指示できます。

このプロパティで使用できる値は、8.0.100 や 8.0.400 などの SDK 機能バンドです。 この値の既定値は、実行中の SDK の SDK 機能バンドです。 たとえば、SDK 9.0.102 の場合、使用する値は 9.0.100 です。 (.NET SDK のバージョン管理方法については、「.NETのバージョン管理方法を参照してください)。

<PropertyGroup>
  <SdkAnalysisLevel>8.0.400</SdkAnalysisLevel>
</PropertyGroup>

詳細については、「 SDK 分析レベルのプロパティと使用法を参照してください。

次の表は、 SDKAnalysisLevelの影響を受ける診断と動作をまとめたものです。

Microsoft。Testing.Platform 関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• IsTestingPlatformApplication
• Enable[NugetPackageNameWithoutDots]
• EnableAspireTesting
• EnableMSTestRunner
• EnableNUnitRunner
• EnablePlaywright
• GenerateTestingPlatformConfigurationFile
• GenerateTestingPlatformEntryPoint
• TestingExtensionsProfile
• TestingPlatformCaptureOutput
• TestingPlatformCommandLineArguments
• TestingPlatformDotnetTestSupport
• TestingPlatformShowTestsFailure
• UseMicrosoftTestingPlatformRunner

IsTestingPlatformApplication

IsTestingPlatformApplication プロパティは、プロジェクトを MTP テスト アプリケーションとして識別します。 .NET 10 以降の SDK は、ソリューションまたはプロジェクトに対して MTP モードでdotnet test実行すると、このプロパティを評価して各プロジェクトを分類します。 テスト フレームワークとプラットフォーム NuGet パッケージは、通常、復元された MSBuild インポートを通じてプロパティを設定します。

プロジェクトがMicrosoftをインポートするとき。Testing.Platform.MSBuild パッケージでは、パッケージを設定していない場合、既定でIsTestingPlatformApplicationがtrueされます。 true値は次の処理を行います。

• テスト プロジェクトへのエントリ ポイントを生成します。
• 構成ファイルを生成します。
• 拡張機能を検出します。

評価されたプロジェクト dotnet test MTP モードで分類すると、プロパティ値によって次の結果が生成されます。

復元をスキップし、復元されたパッケージのインポートを使用できない場合、 IsTestingPlatformApplication は空のままになり、プロジェクトの検出が失敗する可能性があります。 詳細については、No test projects were foundを参照してください。

プロパティを false に設定すると、パッケージへの推移的な依存関係が無効になります。 一時的な依存関係は特定のパッケージを参照する別のプロジェクトを参照するプロジェクトが、itがパッケージを参照しているかのように動作する場合です。 通常、このプロパティは、テスト プロジェクトを参照する非テスト プロジェクトで false するように設定します。 詳細については、「 error CS8892を参照してください。

テスト プロジェクトが MSTest、NUnit、または xUnit を参照している場合、このプロパティは EnableMSTestRunner、 EnableNUnitRunner、または UseMicrosoftTestingPlatformRunner (xUnit の場合) と同じ値に設定されます。

Enable[NugetPackageNameWithoutDots]

パターン Enable[NugetPackageNameWithoutDots] のプロパティを使用して、Microsoftを有効または無効にします。Testing.Platform (MTP) 拡張機能。

たとえば、クラッシュ ダンプ拡張機能 (NuGet パッケージ Microsoft を有効にします。Testing.Extensions.CrashDump)、EnableMicrosoftTestingExtensionsCrashDump を true に設定します。

詳細については、「 拡張機能を有効または無効にするを参照してください。

EnableAspireTesting

MSTest プロジェクト SDK を使用する場合は、EnableAspireTesting プロパティを使用して、usingとAspireでテストするために必要なすべての依存関係と既定のMSTest ディレクティブを取り込むことができます。 このプロパティは、MSTest 3.4 以降のバージョンで使用できます。

詳細については、「Aspireを使用したテスト」を参照してください。

EnablePlaywright

MSTest プロジェクト SDK を使用する場合は、EnablePlaywright プロパティを使用して、usingとPlaywrightでテストするために必要なすべての依存関係と既定のMSTest ディレクティブを取り込むことができます。このプロパティは、MSTest 3.4 以降のバージョンで使用できます。

詳細については、「 Playwright」を参照してください。

EnableMSTestRunner

EnableMSTestRunner プロパティは、VSTest に代わる軽量で移植可能な MTP の使用を有効または無効にします。 このプロパティは、MSTest 3.2 以降のバージョンで使用できます。

EnableNUnitRunner

EnableNUnitRunner プロパティは、NUnit ランナーの使用を有効または無効にします。 NUnit ランナーは、VSTest の軽量で移植可能な代替手段です。 このプロパティは、バージョン 5.0 以降の NUnit3TestAdapter で使用できます。

UseMicrosoftTestingPlatformRunner

UseMicrosoftTestingPlatformRunner プロパティは、xUnit.v3 テスト プロジェクトでの MTP ランナーの使用を有効または無効にします。

GenerateTestingPlatformEntryPoint

GenerateTestingPlatformEntryPoint プロパティを false に設定すると、MTP を使用するテスト プロジェクトのプログラム エントリ ポイントの自動生成が無効になります。 このプロパティは、エントリ ポイントを手動で定義するとき、またはエントリ ポイントも含まれる実行可能ファイルからテスト プロジェクトを参照するときに、 false に設定できます。

詳細については、「 error CS8892を参照してください。

VSTest プロジェクトのエントリ ポイントの生成を制御するには、 GenerateProgramFile プロパティを使用します。

GenerateTestingPlatformConfigurationFile

GenerateTestingPlatformConfigurationFile プロパティは、IsTestingPlatformApplication がtrueされている場合にのみ使用できます。 出力フォルダー内の 構成ファイル のコピーと名前の変更を許可するために使用されます。

TestingPlatformCaptureOutput

TestingPlatformCaptureOutput プロパティは、dotnet testを使用して MTP テストを実行するときに、テスト実行可能ファイルが書き込むすべてのコンソール出力をキャプチャして非表示にするかどうかを制御します。 既定では、コンソール出力は非表示になっています。 この出力には、バナー、バージョン情報、および書式設定されたテスト情報が含まれます。 MSBuild 出力と共にこの情報を表示するには、このプロパティを false に設定します。

詳細については、「 Show の完全なプラットフォーム出力を参照してください。

TestingPlatformCommandLineArguments

TestingPlatformCommandLineArguments プロパティを使用すると、dotnet testを使用して MTP テストを実行するときに、テスト アプリに対するコマンド ライン引数を指定できます。 次のプロジェクト ファイル スニペットは、例を示しています。

<PropertyGroup>
  ...
  <TestingPlatformCommandLineArguments>--minimum-expected-tests 10</TestingPlatformCommandLineArguments>
</PropertyGroup>

条件を使用して、異なるテスト フレームワークまたは拡張機能を使用するプロジェクトに異なる引数を渡すこともできます。 詳細については、「 テスト フレームワークまたは拡張機能が混在するソリューション」を参照してください。

TestingPlatformDotnetTestSupport

TestingPlatformDotnetTestSupport プロパティを使用すると、dotnet testの VSTest モードを使用するときに MTP アプリをテストできます。

詳細については、「 dotnet test」を使用したテストを参照してください。

TestingPlatformShowTestsFailure

TestingPlatformShowTestsFailure プロパティを使用すると、dotnet testを使用してテストを実行するときに、単一のエラーまたは失敗したテストのすべてのエラーを報告するかどうかを制御できます。 デフォルトでは、テストの失敗は .log ファイルにまとめられ、テスト プロジェクトごとに 1 つの失敗が MSBuild に報告されます。 失敗したテストごとのエラーを表示するには、このプロパティをプロジェクト ファイルで true に設定します。

TestingExtensionsProfile

MSTest プロジェクト SDK を使用すると、TestingExtensionsProfile プロパティを使用して、使用するプロファイルを選択できます。 次の表に、許容値を示します。

詳細については、 MTP プロファイルを参照してください。

VSTest 関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• IsTestProject
• UseVSTest

IsTestProject

IsTestProject プロパティは、Microsoft.NET によって true に設定されます。Test.Sdk NuGet パッケージ。 プロジェクトが VSTest テスト プロジェクトであるかどうかを示し、 dotnet testで認識されるようにします。

UseVSTest

UseVSTest を使用するときに MTP から true ランナーに切り替えるには、 プロパティを に設定します。

MSTest 関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• MSTestAnalysisMode

MSTestAnalysisMode

このプロパティは、どのアナライザーがどの重大度で有効になっているかを決定します。 詳細については、MSTest コード分析 を参照してください。

ホスティング関連のプロパティ

このセクションでは、次の MSBuild プロパティについて説明します。

• AppHostDotNetSearch
• AppHostRelativeDotNet
• EnableComHosting
• EnableDynamicLoading

AppHostDotNetSearch

AppHostDotNetSearch プロパティはアプリケーション用に生成されたネイティブ実行可能ファイルが.NETインストールを検索する方法を構成します。 このプロパティは、ビルドではなく、発行時に生成された実行可能ファイルにのみ影響します。

<PropertyGroup>
  <AppHostDotNetSearch>Global</AppHostDotNetSearch>
</PropertyGroup>

次の表に、有効な値を示します。 複数の値をセミコロンで区切って指定できます。

このプロパティは、.NET 9 で導入されました。

AppHostRelativeDotNet

AppHostRelativeDotNet プロパティを使用すると、構成時に.NETインストールを検索するアプリ実行可能ファイルの相対パスを指定できます。 AppHostRelativeDotNet プロパティを設定すると、AppHostDotNetSearchがAppRelative。 このプロパティは、ビルドではなく、発行時に生成された実行可能ファイルにのみ影響します。

<PropertyGroup>
  <AppHostRelativeDotNet>./relative/path/to/runtime</AppHostRelativeDotNet>
</PropertyGroup>

このプロパティは、.NET 9 で導入されました。

EnableComHosting

EnableComHosting プロパティは、アセンブリで COM サーバーが提供されることを示します。 EnableComHosting を true に設定することは、EnableDynamicLoading が true であることも意味します。

<PropertyGroup>
  <EnableComHosting>True</EnableComHosting>
</PropertyGroup>

詳細については、「Expose .NET コンポーネントを COMする」を参照してください。

EnableDynamicLoading

EnableDynamicLoading プロパティは、アセンブリが動的に読み込まれたコンポーネントであることを示します。 このコンポーネントには、COM ライブラリ、またはネイティブ ホストから使用またはプラグインとして使用できる非 COM ライブラリを指定できます。 このプロパティを true に設定すると、次のような効果があります。

• " .runtimeconfig.json" ファイルが生成される。
• RollForward は LatestMinor に設定されます。
• NuGet 参照がローカルにコピーされる。

<PropertyGroup>
  <EnableDynamicLoading>true</EnableDynamicLoading>
</PropertyGroup>

生成されたファイルのプロパティ

次のプロパティは、生成されたファイルのコードに関するものです。

• CompilerGeneratedFilesOutputPath
• DisableImplicitNamespaceImports
• EmitCompilerGeneratedFiles
• ImplicitUsings

CompilerGeneratedFilesOutputPath

CompilerGeneratedFilesOutputPath プロパティは、EmitCompilerGeneratedFiles が true に設定されている場合にソース ジェネレーターの出力ファイルが書き込まれるディレクトリを指定します。 パスは、絶対パスでも、プロジェクト ディレクトリに対する相対パスでもかまいません。 このプロパティを設定しない場合、生成されたファイルは中間出力パス (通常は ) の下に生成された<に配置されます。

<PropertyGroup>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
  <CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
</PropertyGroup>

このプロパティをプロジェクトのソース ツリー内のパスに設定すると、生成されたファイルが将来のビルドによってソース ファイルとして取得される可能性があります。 二重コンパイルを回避するには、生成されたファイルを Compile 項目から除外します。

<ItemGroup>
  <Compile Remove="$(CompilerGeneratedFilesOutputPath)\**\*.cs" />
</ItemGroup>

DisableImplicitNamespaceImports

DisableImplicitNamespaceImports プロパティを使用すると、6 以降のバージョンを対象とするVisual Basic プロジェクトで暗黙的な名前空間のインポート.NET無効にすることができます。 暗黙的な名前空間は、Visual Basic プロジェクトにグローバルにインポートされる既定の名前空間です。 暗黙的な名前空間のインポートを無効にするには、このプロパティを true に設定します。

<PropertyGroup>
  <DisableImplicitNamespaceImports>true</DisableImplicitNamespaceImports>
</PropertyGroup>

EmitCompilerGeneratedFiles

EmitCompilerGeneratedFiles プロパティは、ビルド中にソース ジェネレーターの出力ファイルをディスクに書き込むかどうかを制御します。 この動作を有効にするには、このプロパティを true に設定します。 既定では、ソース ジェネレーターの出力はメモリ内にのみ存在し、ディスクには書き込まれません。

<PropertyGroup>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
</PropertyGroup>

このプロパティを true に設定すると、CompilerGeneratedFilesOutputPath プロパティを使用して別の場所を指定しない限り、<ファイルは中間出力パス (通常は obj/>configuration</>targetframework/generated) の下に生成されたサブディレクトリに配置されます。

生成されたファイルをディスクに書き込んで、それらを検査できます。 生成されたファイルをソース管理にコミットするのは、特定の理由がある場合 (ビルド環境でジェネレーターを使用できない場合や、確定的に生成された成果物を確認する必要がある場合など) のみです。

ImplicitUsings

ImplicitUsings プロパティを使用すると、6 以降のバージョンと C# 10 以降のバージョンを対象とする C# プロジェクトで暗黙的な global using ディレクティブ.NET有効または無効にすることができます。 この機能を有効にすると、.NET SDK は、プロジェクト SDK の種類に基づいて、一連の既定の名前空間に対して global using ディレクティブを追加します。 暗黙的な true ディレクティブを有効にするには、このプロパティを enable または global using に設定します。 暗黙的な global using ディレクティブを無効にするには、このプロパティを削除するか、false または disable に設定します。

<PropertyGroup>
  <ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>

明示的な global using ディレクティブを定義するには、Using 項目を追加します。

Items

MSBuild 項目はビルド システムへの入力です。 項目は、要素名である型に従って指定されます。 たとえば、Compile と Reference は 2 つの一般的な項目の種類です。 .NET SDK では、次の追加項目の種類を使用できます。

• AssemblyMetadata
• InternalsVisibleTo
• FrameworkReference
• パッケージリファレンス
• TrimmerRootAssembly
• Using

これらの項目には、標準の項目属性 (Include や Update など) を使用できます。 Include を使用して新しい項目を追加し、Update を使用して既存の項目を変更します。 たとえば、Update は、多くの場合、.NET SDK によって暗黙的に追加された項目を変更するために使用されます。

AssemblyMetadata

AssemblyMetadata 項目によって、キーと値のペアの AssemblyMetadataAttribute アセンブリ属性を指定します。 Include メタデータがキーになり、Value メタデータが値になります。

<ItemGroup>
  <AssemblyMetadata Include="Serviceable" Value="True" />
</ItemGroup>

InternalsVisibleTo

InternalsVisibleTo 項目によって、指定されたフレンド アセンブリの InternalsVisibleToAttribute アセンブリ属性を生成します。

<ItemGroup>
  <InternalsVisibleTo Include="MyProject.Tests" />
</ItemGroup>

フレンド アセンブリが署名されている場合は、省略可能な Key メタデータを指定して、その完全な公開キーを指定できます。 Key メタデータを指定しておらず、$(PublicKey) が使用可能な場合は、そのキーが使用されます。 それ以外の場合、属性に公開キーは追加されません。

FrameworkReference

FrameworkReference 項目は、.NET共有フレームワークへの参照を定義します。

Include 属性は、フレームワーク ID を指定します。

次の例のプロジェクト ファイル スニペットは、Microsoft.AspNetCore.App 共有フレームワークを参照しています。

<ItemGroup>
  <FrameworkReference Include="Microsoft.AspNetCore.App" />
</ItemGroup>

PackageReference

PackageReference 項目では、NuGet パッケージへの参照が定義されます。

Include 属性は、パッケージ ID を指定します。 Version 属性では、バージョンまたはバージョン範囲を指定します。 最小バージョン、最大バージョン、範囲、厳密一致を指定する方法については、「バージョン範囲」を参照してください。

次の例のプロジェクト ファイル スニペットでは、System.Runtime パッケージを参照しています。

<ItemGroup>
  <PackageReference Include="System.Runtime" Version="4.3.0" />
</ItemGroup>

などのメタデータを使用してPrivateAssetsすることもできます。

<ItemGroup>
  <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0">
    <PrivateAssets>all</PrivateAssets>
  </PackageReference>
</ItemGroup>

詳細については、プロジェクト ファイルのパッケージ参照に関するページを参照してください。

TrimmerRootAssembly

TrimmerRootAssembly 項目ではアセンブリを "トリミング" から除外できます。 トリミングとは、パッケージ化されたアプリケーションからランタイムの未使用部分を削除するプロセスです。 必要な参照がトリミングによって間違って削除されることもあります。

次の XML では、トリミングから System.Security アセンブリが除外されます。

<ItemGroup>
  <TrimmerRootAssembly Include="System.Security" />
</ItemGroup>

詳細については、「トリミングのオプション」を参照してください。

Using

Using 項目を使用すると、C# プロジェクト全体で名前空間をグローバルに含めることができるので、ソース ファイルの先頭に名前空間の using ディレクティブを追加する必要はありません。 この項目は、Visual Basic プロジェクトで同じ目的で使用できる Import 項目に似ています。 このプロパティは、.NET 6 以降で使用できます。

<ItemGroup>
  <Using Include="My.Awesome.Namespace" />
</ItemGroup>

また、Using 項目を使用して、グローバルな using <alias> および using static <type> ディレクティブを定義することもできます。

<ItemGroup>
  <Using Include="My.Awesome.Namespace" Alias="Awesome" />
</ItemGroup>

例えば次が挙げられます。

• <Using Include="Microsoft.AspNetCore.Http.Results" Alias="Results" /> は global using Results = global::Microsoft.AspNetCore.Http.Results; を出力します
• <Using Include="Microsoft.AspNetCore.Http.Results" Static="True" /> は global using static global::Microsoft.AspNetCore.Http.Results; を出力します

詳細については、エイリアス化された using ディレクティブ と using static <type> ディレクティブを参照してください。

項目のメタデータ

標準の MSBuild 項目属性に加えて、.NET SDK では次の項目メタデータ タグを使用できます。

• CopyToPublishDirectory
• LinkBase

CopyToPublishDirectory

MSBuild 項目の CopyToPublishDirectory メタデータにより、項目が発行ディレクトリにコピーされるタイミングが制御されます。 次の表に、許容値を示します。

パフォーマンスの観点からは、インクリメンタル ビルドが有効になるので PreserveNewest をお勧めします。 代わりに Always を使用せず、IfDifferent を使用すると、I/O 書き込みが無効になります。

<ItemGroup>
  <None Update="appsettings.Development.json" CopyToOutputDirectory="PreserveNewest" CopyToPublishDirectory="PreserveNewest" />
</ItemGroup>

LinkBase

プロジェクト ディレクトリとそのサブディレクトリの外部にある項目の場合、発行先で項目のコピー先を決定するために、項目の Link メタデータが使用されます。 Link は、プロジェクト ツリーの外部にある項目をVisual Studioのソリューション エクスプローラー ウィンドウに表示する方法も決定します。

プロジェクト コーンの外部にある項目に対して Link が指定されていない場合は、既定で %(LinkBase)\%(RecursiveDir)%(Filename)%(Extension) になります。 LinkBase を使用して、プロジェクト コーンの外部の項目に適切なベース フォルダーを指定できます。 ベース フォルダーの下のフォルダー階層は、RecursiveDir によって保持されます。 LinkBase を指定しないと、それは Link パスから省略されます。

<ItemGroup>
  <Content Include="..\Extras\**\*.cs" LinkBase="Shared"/>
</ItemGroup>

次の図は、前の項目 Include glob を介して含まれるファイルがソリューション エクスプローラーでどのように表示されるかを示しています。

ソリューション エクスプローラー LinkBase metadata.

こちらも参照ください

• MSBuild スキーマ リファレンス
• MSBuild の共通プロパティ
• NuGet pack の MSBuild プロパティ
• NuGet restore の MSBuild プロパティ
• ビルドのカスタマイズ