一般 MSBuild 專案屬性

  • 發行項

下表列出 Visual Studio 專案檔中所定義或 MSBuild 提供的 .targets 檔案中所包含的最常用屬性。

Visual Studio 中的專案檔 (.csproj、.vbproj、.vcxproj 及其他) 包含 MSBuild XML 程式碼，該程式碼會在您使用 IDE 建置專案時執行。 專案通常會匯入一或多個 .targets 檔案，用於定義其建置流程。 如需詳細資訊，請參閱 MSBuild .targets 檔案。

設定屬性值時，請記住，許多匯入的檔案中都可能會設定、重設或使用通用屬性。 因此，設定屬性的位置很重要--在專案檔中、在 Directory.Build.props 中，或是在另一個匯入的檔案中。 如果您在某處設定屬性，但未取得預期的結果，請考慮專案所匯入的所有檔案中屬性變更或使用的位置和方式，包括當您使用 Sdk 屬性時隱含新增的匯入項目。 請參閱 選擇將屬性新增至 .props 或 .targets 檔案。 前置處理有助於解決此問題 (請參閱 MSBuild 命令列參考中的 /preprocess 或 /pp 命令列選項)。

通用屬性和參數的清單

屬性或參數名稱 專案類型 描述
AdditionalLibPaths .NET 指定其他資料夾，編譯器會在這些資料夾中尋找參考組件。
AddModules .NET 讓編譯器將所指定檔案的類型資訊全部提供給您正在編譯的專案。 這個屬性相當於 /addModules 編譯器參數。
ALToolPath .NET AL.exe 的路徑。 此屬性會覆寫 AL.exe 的目前版本，以使用其他版本。
ApplicationIcon .NET 傳遞至編譯器內嵌為 Win32 圖示的 .ico 圖示檔。 這個屬性相當於 /win32icon 編譯器參數。
ApplicationManifest 全部 指定檔案路徑，這個檔案用於產生外部使用者帳戶控制 (User Account Control，UAC) 資訊清單資訊。 僅適用於目標為 Windows Vista 的 Visual Studio 專案。

大部分情況下，資訊清單是以內嵌方式存在。 不過，如果您使用免註冊的 COM 或 ClickOnce 部署，那麼資訊清單就可能是隨應用程式組件一起安裝的外部檔案。 如需詳細資訊，請參閱本文中的 NoWin32Manifest 屬性。
AssemblyOriginatorKeyFile .NET 指定用來簽署組件的檔案 (.snk 或 .pfx)，此檔案將傳遞至 ResolveKeySource 工作以產生用來簽署組件的實際金鑰。
AssemblySearchPaths .NET 在建置階段參考組件解析期間搜尋的位置清單。 路徑出現在這個清單中的順序是有意義的，因為較早列出的路徑優先於較晚列出的路徑。
AssemblyName .NET 專案建置之後，最後輸出組件的名稱。
屬性或參數名稱 專案類型 描述
BaseAddress .NET 指定主要輸出組件的基底位址。 這個屬性相當於 /baseaddress 編譯器參數。
BaseIntermediateOutputPath 全部 在其中建立所有組態特有中繼輸出資料夾的最上層資料夾。 預設值是 obj\。 下列程式碼為範例：<BaseIntermediateOutputPath>c:\xyz\obj\</BaseIntermediateOutputPath>
BaseOutputPath 全部 指定輸出檔的基底路徑。 如果設定，MSBuild 就會使用 OutputPath = $(BaseOutputPath)\$(Configuration)\。 範例語法：<BaseOutputPath>c:\xyz\bin\</BaseOutputPath>
BuildInParallel 全部 布林值，指出使用多處理器 MSBuild 時會平行建置或平行清除專案參考。 預設值為 true，表示系統有多個核心或處理器時，專案將會平行建置。
BuildProjectReferences 全部 布林值，指出專案參考是否由 MSBuild 建置。 如果您要在 Visual Studio 整合式開發環境 (IDE) 中建置專案，會自動設定為 false，否則設定為 true。 可以在命令列上指定 -p:BuildProjectReferences=false 以避免檢查參考的專案是否為最新。
屬性或參數名稱 專案類型 描述
CleanFile 全部 做為「清除快取」使用之檔案的名稱。清除快取是所產生檔案的清單，這些檔案將要在清除作業期間刪除。 建置流程會將這個檔案放入中繼輸出路徑。

此屬性只會指定檔案名稱，不包含路徑資訊。
CodePage .NET 指定編譯過程中所有原始程式碼檔使用的字碼頁。 這個屬性相當於 /codepage 編譯器參數。
CompilerResponseFile .NET 可傳遞至編譯器工作的選擇性回應檔。
組態 全部 您要建置的設定，通常是 Debug 或 Release，但可在解決方案和專案層級上進行設定。
CscToolPath C# csc.exe (C# 編譯器) 的路徑。
CustomAfterMicrosoftCommonTargets 全部 專案檔或目標檔案的名稱，該檔案會在通用目標匯入之後自動匯入。
CustomBeforeMicrosoftCommonTargets 全部 專案檔或 targets 檔的名稱，該檔案會在一般 targets 匯入之前自動匯入。
屬性或參數名稱 專案類型 描述
DebugSymbols 全部 布林值，指出建置是否要產生符號。

在命令列上設定 -p:DebugSymbols=false 時，會停用產生程式資料庫 (.pdb) 符號檔。
DebugType 全部 定義您要產生的偵錯資訊層級。 有效值為 "full"、"pdbonly"、"portable"、"embedded" 和 "none"。
DefineConstants .NET 定義條件式編譯器常數。 符號/值組會以分號分隔，並且使用語言相關語法指定：

C#: symbol1; symbol2

Visual Basic：symbol1 = value1, symbol2 = value2

這個屬性相當於 /define 編譯器參數。
DefineDebug 全部 布林值，指出您是否要定義 DEBUG 常數。
DefineTrace 全部 布林值，指出您是否要定義 TRACE 常數。
DelaySign .NET 布林值，指出您是否要延遲簽署組件，而不要完整簽署組件。
具決定性 .NET 布林值，指出編譯器是否應該針對相同的輸入產生相同的組件。 此參數對應編譯器的 /deterministic 參數。
DirectoryBuildPropsPath 全部 指定 Directory.Build.props 檔案的路徑；如果已定義，則此屬性會覆寫預設搜尋演算法。 請參閱自訂您的組建。
DirectoryBuildTargetsPath 全部 指定 Directory.Build.targets 檔案的路徑；如果已定義，則此屬性會覆寫預設搜尋演算法。 請參閱自訂您的組建。
DisableFastUpToDateCheck 全部 僅適用於 Visual Studio 的布林值。 Visual Studio 建置管理程式會使用稱為 FastUpToDateCheck 的處理序，判斷是否必須重建專案使其成為最新版本。 使用這個處理序比使用 MSBuild 判斷的速度快。 將 DisableFastUpToDateCheck 屬性設為 true，可讓您略過 Visual Studio 建置管理程式，並強制使用 MSBuild 判斷專案是否為最新版本。
DocumentationFile .NET 產生為 XML 文件檔案之檔案的名稱。 這個名稱只包含檔案名稱，不包含路徑資訊。
屬性或參數名稱 專案類型 描述
ErrorReport .NET 指定編譯器工作報告編譯器內部錯誤的方式。 有效值為 "prompt"、"send" 或 "none"。這個屬性相當於 /errorreport 編譯器參數。
ExcludeDeploymentUrl .NET 如果專案檔包含下列任何項目，GenerateDeploymentManifest 工作會將 deploymentProvider 標記新增至部署資訊清單：

- UpdateUrl
- InstallUrl
- PublishUrl

不過，若使用 ExcludeDeploymentUrl，即使指定了上述任何 URL，仍可以防止將 deploymentProvider 標記加入至部署資訊清單。 若要防止加入該標記，請將下列屬性加入至您的專案檔：

<ExcludeDeploymentUrl>true</ExcludeDeploymentUrl>

注意：ExcludeDeploymentUrl 不會在 Visual Studio IDE 中公開，只能透過手動編輯專案檔的方式設定。 設定這個屬性不會影響 Visual Studio 內的發行作業，也就是說，deploymentProvider 標記仍會加入至 PublishUrl 所指定的 URL。
FileAlignment .NET 以位元組為單位，指定要對齊輸出檔案區段的位置。 有效的值為 512、1024、2048、4096、8192。 這個屬性相當於 /filealignment 編譯器參數。
FrameworkPathOverride Visual Basic 指定 mscorlib.dll 和 microsoft.visualbasic.dll 的位置。 此參數 (Parameter) 相當於 vbc.exe 編譯器的 /sdkpath 參數 (Switch)。
GenerateDocumentation .NET 布林值參數，指出建置是否要產生文件。 如果為 true，則建置會產生文件資訊，並將該資訊連同建置工作所建立的可執行檔或程式庫的名稱放入 .xml 檔。
GenerateFullPaths C# 使用 -fullpaths 編譯器選項在輸出中產生檔案名稱的完整路徑。
GenerateSerializationAssemblies .NET 指出 XML 序列化組件是否應該由 SGen.exe 產生，其可設為開啟、自動或關閉。 這個屬性僅適用於以 .NET Framework 為目標的組件。 若要產生適用於 .NET Standard 或 .NET Core 組件的 XML 序列化組件，請參考 Microsoft.XmlSerializer.Generator NuGet 套件。
屬性或參數名稱 專案類型 描述
ImportDirectoryBuildProps 全部 布林值，指出是否要匯入 Directory.Build.props 檔案。 請參閱自訂您的組建。
ImportDirectoryBuildTargets 全部 布林值，指出是否要匯入 Directory.Build.targets 檔案。 請參閱自訂您的組建。
IntermediateOutputPath 全部 如果沒有指定路徑，則為衍生自 BaseIntermediateOutputPath 的完整中繼輸出路徑。 例如，obj\debug\。
KeyContainerName 全部 強式名稱金鑰容器的名稱。
KeyOriginatorFile 全部 強式名稱金鑰檔的名稱。
ModuleAssemblyName .NET 組件的名稱，編譯的模組將合併到該組件中。 這個屬性相當於 /moduleassemblyname 編譯器參數。
MSBuildProjectExtensionsPath 全部 指定專案延伸模組的路徑位置。 根據預設，這會採用與 BaseIntermediateOutputPath 相同的值。
MSBuildTreatWarningsAsErrors 全部 布林值，指示 MSBuild 將所有警告視為錯誤，除非錯誤已隱藏。
MSBuildWarningsAsErrors 全部 指定要視為錯誤的警告代碼清單。 以分號分隔多個警告。 如果您使用 .NET SDK 屬性 WarningsAsErrors，MSBuildWarningsAsErrors 會預設為 WarningsAsErrors 的值。
MSBuildWarningsAsMessages 全部 藉由將警告代碼視為低重要性訊息來指定要隱藏的警告代碼清單。 以分號分隔多個警告。 請注意，MSBuild 發出的某些警告無法使用此屬性來隱藏；若要隱藏這些警告，請使用命令列參數 -warnAsMessage。 如果您使用 .NET SDK 屬性 NoWarn，MSBuildWarningsAsMessages 會預設為 NoWarn 的值。
屬性或參數名稱 專案類型 描述
NoLogo 全部 布林值，指出您是否要關閉編譯器標誌。 這個屬性相當於 /nologo 編譯器參數。
NoStdLib .NET 布林值，指出是否要避免參考標準程式庫 (mscorlib.dll)。 預設值是 false。
NoVBRuntimeReference Visual Basic 布林值，指出是否應加入 Visual Basic 執行階段 (Microsoft.VisualBasic.dll) 作為專案中的參考。
NoWarn .NET 隱藏指定的警告。 您只需要指定警告識別項的數值部分。 若有多個警告，則會以分號分隔。 此參數對應編譯器的 /nowarn 參數。
NoWin32Manifest .NET 布林值，指出使用者帳戶控制 (UAC) 資訊清單資訊是否將會內嵌於應用程式的可執行檔中。 僅適用於目標為 Windows Vista 的 Visual Studio 專案。 在使用 ClickOnce 和免註冊的 COM 所部署的專案中，會忽略這個項目。 False (預設值) 會指定將使用者帳戶控制 (UAC) 資訊清單資訊內嵌於應用程式的可執行檔中。 True 則會指定不內嵌 UAC 資訊清單資訊。

此屬性僅適用於目標為 Windows Vista 的 Visual Studio 專案。 在使用 ClickOnce 和免註冊的 COM 所部署的專案中，會忽略這個屬性。

您應該僅在不希望 Visual Studio 於應用程式的可執行檔中內嵌任何資訊清單資訊時，才新增 NoWin32Manifest；這個流程稱為虛擬化。 若要使用虛擬化，請連同 <ApplicationManifest> 一起設定 <NoWin32Manifest>，如下所示：

- 如果是 Visual Basic 專案，請移除 <ApplicationManifest> 節點。 (在 Visual Basic 專案中，<ApplicationManifest> 節點存在時會忽略 <NoWin32Manifest>。)
- 如果是 C# 專案，請將 <ApplicationManifest> 設定為 False，並將 <NoWin32Manifest> 設定為 True。 (在 C# 專案中，<ApplicationManifest> 會覆寫 <NoWin32Manifest>)。
此屬性相當於 vbc.exe 的 /nowin32manifest 編譯器參數。
最佳化 .NET 布林值，設定為 true 時，會啟用編譯器最佳化。 這個屬性相當於 /optimize 編譯器參數。
OptionCompare VisualBasic 指定如何進行字串比較。 有效值為 "binary" 或 "text"。此屬性相當於 vbc.exe 的 /optioncompare 編譯器參數。
OptionExplicit Visual Basic 布林值，設定為 true 時，需要在原始程式碼中明確宣告變數。 這個屬性相當於 /optionexplicit 編譯器參數。
OptionInfer Visual Basic 布林值，設定為 true 時，會啟用變數的類型推斷。 這個屬性相當於 /optioninfer 編譯器參數。
OptionStrict Visual Basic 布林值，設定為 true 時，會讓建置工作強制執行嚴格的類型語意來限制隱含類型轉換。 此屬性相當於 vbc.exe 編譯器的 /optionstrict 參數。
OutDir 全部 指出專案或解決方案的最終輸出位置。 建置解決方案時，OutDir 可用來將多個專案輸出收集在一個位置中。 此外，OutDir 會包含在用於解析參考的 AssemblySearchPaths 中。 例如，bin\Debug。
OutputPath 全部 指定輸出目錄的路徑 (相對於專案目錄)，例如非 AnyCPU 建置中的 bin\Debug 或 bin\Debug\$(Platform)。
OutputType 全部 指定輸出檔的檔案格式。 這個參數的值可以是下列其中一個：

- Library。 建立程式碼程式庫 (預設值)。
- Exe。 建立主控台應用程式 (Console Application)。
- Module。 建立模組。
- Winexe。 建立 Windows 程式。

對於 C# 和 Visual Basic，此屬性相當於 /target 參數。 輸出類型可以透過推斷來自動覆寫。 請參閱 OutputType 會針對 WPF 和 WinForms 應用程式設定為 WinExe。 將 DisableWinExeOutputInference 設定為 true 以停用推斷。
OverwriteReadOnlyFiles 全部 布林值，指出您要讓建置覆寫唯讀檔案或是觸發錯誤。
屬性或參數名稱 專案類型 描述
PathMap .NET 指定如何將實體路徑對應到編譯器所輸出的來源路徑名稱。 此屬性相當於編譯器的 /pathmap 參數。
PdbFile .NET 您所發出 .pdb 檔案的檔案名稱。 此屬性相當於 csc.exe 編譯器的 /pdb 參數。
平台 全部 做為您建置目標的作業系統。 .NET Framework 建置的範例包括「任何 CPU」、「x86」和「x64」。
ProcessorArchitecture .NET 解析組件參考時使用的處理器架構。 有效值為 "msil"、"x86"、"amd64" 或 "ia64"。
ProduceOnlyReferenceAssembly .NET 布林值，指示編譯器只發出參考組件，而不發出已編譯的程式碼。 無法與 ProduceReferenceAssembly 搭配使用。 此屬性對應於 vbc.exe 和 csc.exe 編譯器的 /refonly 參數。
ProduceReferenceAssembly .NET 布林值，設定為 true 時會產生目前組件的參考組件。 使用這項功能時，Deterministic 應該是 true。 此屬性對應於 vbc.exe 和 csc.exe 編譯器的 /refout 參數。
RegisterAssemblyMSBuildArchitecture 僅限 Windows 指定註冊 Managed DLL 的預設架構。 此屬性很有用，因為 COM 會使用 Windows 登錄將註冊儲存在架構特定的 Hives 中。 例如，在 Windows 系統上，AnyCPU 受控元件可以在 64 位 Hive 和/或 32 位 Hive 中註冊其類型，而組建會使用這個屬性來判斷要使用的架構特定登錄區。 有效值包括 「x86」、“x64” 和 “ARM64”。
RegisterForCOMInterop 僅限 Windows 指出受控應用程式會公開 COM 物件（COM 可呼叫包裝函式）。 請參閱 建置頁面 - 輸出一節。 此設定只會影響專案建置所在的計算機。 如果您要部署到其他計算機，請呼叫 regasm.exe 以在目標電腦上註冊元件。
RemoveIntegerChecks Visual Basic 布林值，指出是否要停用整數溢位錯誤檢查。 預設值是 false。 此屬性相當於 vbc.exe 編譯器的 /removeintchecks 參數。
RootNamespace 全部 命名內嵌資源時使用的根命名空間。 這個命名空間是內嵌資源資訊清單名稱的一部分。
屬性或參數名稱 專案類型 描述
Satellite_AlgorithmId .NET 建立附屬組件時要使用之 AL.exe 雜湊演算法的 ID。
Satellite_BaseAddress .NET 使用 CreateSatelliteAssemblies 目標建置文化特性特有的附屬組件時，要使用的基底位址。
Satellite_CompanyName .NET 產生附屬組件期間要傳入 AL.exe 的公司名稱。
Satellite_Configuration .NET 產生附屬組件期間要傳入 AL.exe 的組態名稱。
Satellite_Description .NET 產生附屬組件期間要傳入 AL.exe 的描述文字。
Satellite_EvidenceFile .NET 在資源名稱為 "Security.Evidence" 的附屬組件中內嵌指定的檔案。
Satellite_FileVersion .NET 指定附屬組件中 [檔案版本] 欄位的字串。
Satellite_Flags .NET 指定附屬組件中 [旗標] 欄位的值。
Satellite_GenerateFullPaths .NET 設定讓建置工作針對錯誤訊息中報告的任何檔案使用絕對路徑。
Satellite_LinkResource .NET 將指定的資源檔連結至附屬組件。
Satellite_MainEntryPoint .NET 指定在產生附屬組件期間模組轉換成可執行檔時，用來做為進入點之方法的完整名稱 (也就是 class.method)。
Satellite_ProductName .NET 指定附屬組件中 [產品] 欄位的字串。
Satellite_ProductVersion .NET 指定附屬組件中 [ProductVersion] 欄位的字串。
Satellite_TargetType .NET 將附屬組件輸出檔的檔案格式指定為 "library"、"exe" 或 "win"。預設值為 "library"。
Satellite_Title .NET 指定附屬組件中 [標題] 欄位的字串。
Satellite_Trademark .NET 指定附屬組件中 [商標] 欄位的字串。
Satellite_Version .NET 指定附屬組件的版本資訊。
Satellite_Win32Icon .NET 將 .ico 圖示檔插入附屬組件。
Satellite_Win32Resource .NET 將 Win32 資源 (.res 檔案) 插入附屬組件。
SGenToolPath .NET 選擇性的工具路徑，指出目前版本的 SGen.exe 遭到覆寫時，取得 SGen.exe 的位置。
屬性或參數名稱 專案類型 描述
SGenUseProxyTypes .NET 布林值，指出是否要由 SGen.exe 產生 Proxy 類型。 這只適用於 GenerateSerializationAssemblies 設定為開啟時。

SGen 目標會使用這個屬性設定 UseProxyTypes 旗標。 此屬性預設為 true，而且沒有 UI 可用來變更這個屬性。 若要產生非 WebService 類型的序列化組件，請先將這個屬性新增至專案檔並將它設定為 false，再匯入 Microsoft.Common.Targets 或 C#/VB.targets。
SkipInvalidConfigurations 全部 若是 true，會在不正確平台和設定組合上產生警告，但不會讓建置失敗；若是 false 或未定義 (預設值) 時，則會產生錯誤。
StartupObject .NET 指定包含 Main 方法或 Sub Main 程序的類別或模組。 這個屬性相當於 /main 編譯器參數。
SubsystemVersion .NET 指定所產生的可執行檔能夠使用的最低子系統版本。 這個屬性相當於 /subsystemversion 編譯器參數。 如需這個屬性之預設值的資訊，請參閱 /subsystemversion (Visual Basic) 或 /subsystemversion (C# 編譯器選項)。
TargetCompactFramework .NET 執行您所建置應用程式所需的 .NET Compact Framework 版本。 指定這個屬性可讓您參考無法以其他方式參考的某些 Framework 組件。
TargetFrameworkVersion .NET 執行您所建置應用程式所需的 .NET Framework 版本。 指定這個屬性可讓您參考無法以其他方式參考的某些 Framework 組件。
TreatWarningsAsErrors .NET 布林值參數，如果為 true，表示會將所有警告視為錯誤。 這個參數 (Parameter) 相當於 /nowarn 編譯器參數 (Switch)。
UseCommonOutputDirectory .NET 布林值屬性，當您想要解決方案中的所有建置輸出都使用相同的輸出目錄時，可以將其設定為 true。 若是 true，則參考的專案輸出不會複製到使用這些相依性的專案，就像此設定為 false 時的情況一樣。 將此參數設定為 true 不會變更任何專案的實際輸出目錄；您仍然必須針對需要輸出目錄的每個專案，將輸出目錄設定所需的通用輸出目錄。
UseHostCompilerIfAvailable .NET 布林值參數，如果為 true，表示建置工作會使用內含式 (In-Process) 編譯器物件 (如果有的話)。 此參數僅供 Visual Studio 使用。
Utf8Output .NET 布林值參數，如果為 true，則會使用 UTF-8 編碼記錄編譯器輸出。 這個參數 (Parameter) 相當於 /utf8Output 編譯器參數 (Switch)。
屬性或參數名稱 專案類型 描述
VbcToolPath Visual Basic 選擇性路徑，指出目前的 vbc.exe 版本遭到覆寫時，vbc.exe 的另一個位置。
VbcVerbosity Visual Basic 指定 Visual Basic 編譯器輸出的詳細資訊。 有效值為 "Quiet"、"Normal" (預設值) 或 "Verbose"。
VisualStudioVersion 全部 指定考慮用於執行這個專案的 Visual Studio 版本。 如果未指定此屬性，MSBuild 會將期設定為 {VisualStudioMajorVersion}.0 預設值；例如，針對 Visual Studio 2022 的所有版本，該值為 17.0。

這個屬性會在數種專案類型中用來指定組建所使用的一組目標。 如果專案的 ToolsVersion 設定為 4.0 (含) 以上，則會使用 VisualStudioVersion 指定要使用的子工具組。 如需詳細資訊，請參閱 Toolset (ToolsVersion)。
WarningsAsErrors .NET 指定要視為錯誤的警告清單。 這個參數 (Parameter) 相當於 /warnaserror 編譯器參數 (Switch)。
WarningLevel 全部 針對編譯器發出的警告，指定要傳遞至編譯器的警告層級。 此設定不會影響 MSBuild 警告，這些警告沒有層級指定。 請參閱 C# 編譯器文件中的警告層級和 C++ 編譯器文件中的 /W (警告層級)。
WarningsNotAsErrors .NET 指定不要視為錯誤的警告清單。 這個參數 (Parameter) 相當於 /warnaserror 編譯器參數 (Switch)。
Win32Manifest .NET 應內嵌於最終組件中的資訊清單檔案名稱。 這個參數 (Parameter) 相當於 /win32Manifest 編譯器參數 (Switch)。
Win32Resource .NET 要內嵌於最終組件中的 Win32 資源檔案名稱。 這個參數 (Parameter) 相當於 /win32resource 編譯器參數 (Switch)。

.NET SDK 專案特有的屬性，例如 TargetFramework，記載於 Framework 屬性中。

另請參閱