Skip to content

Document RoslynCompilerType #45802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 21, 2025
Merged

Document RoslynCompilerType #45802

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ede1780
Document RoslynCompilerType
jjonescz Apr 14, 2025
0705367
Fix lint error
jjonescz Apr 14, 2025
77ee590
Improve wording
jjonescz Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions docs/core/project-sdk/msbuild-props.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,8 +679,7 @@ The following MSBuild properties are documented in this section:
- [OptimizeImplicitlyTriggeredBuild](#optimizeimplicitlytriggeredbuild)
- [DisableRuntimeMarshalling](#disableruntimemarshalling)
- [BuildWithNetFrameworkHostedCompiler](#buildwithnetframeworkhostedcompiler)
- [RoslynUseSdkCompiler](#roslynusesdkcompiler)
- [RoslynUseMSBuildCompiler](#roslynusemsbuildcompiler)
- [RoslynCompilerType](#roslyncompilertype)

C# compiler options, such as `LangVersion` and `Nullable`, can also be specified as MSBuild properties in your project file. For more information, see [C# compiler options](../../csharp/language-reference/compiler-options/index.md).

Expand Down Expand Up @@ -847,24 +846,17 @@ The `DisableRuntimeMarshalling` property enables you to specify that you would l

### BuildWithNetFrameworkHostedCompiler

When using .NET Framework MSBuild, `BuildWithNetFrameworkHostedCompiler=true` ensures that
a C#/VB compiler corresponding to the current SDK version is used
instead of the default version that ships with MSBuild.
When this property is set to `true`, the .NET Framework version of the compiler is used, unlike `RoslynUseSdkCompiler`.
In some cases, this behavior happens automatically when it is detected that MSBuild and SDK versions are different,
and then you can set `BuildWithNetFrameworkHostedCompiler=false` to opt out of the behavior.
Specifying `BuildWithNetFrameworkHostedCompiler=true` is the equivalent of specifying `RoslynCompilerType=FrameworkPackage`. For more information, see [RoslynCompilerType](#roslyncompilertype).
Specifying `BuildWithNetFrameworkHostedCompiler=false` ensures the automatic opt in to `RoslynCompilerType=FrameworkPackage` does not happen.
If `RoslynCompilerType` is specified explicitly, `BuildWithNetFrameworkHostedCompiler` has no effect.

### RoslynUseSdkCompiler
### RoslynCompilerType

When using .NET Framework MSBuild, `RoslynUseSdkCompiler=true` ensures that
a C#/VB compiler corresponding to the current SDK version is used
instead of the default version that ships with MSBuild.
When this property is set to `true`, the .NET Core version of the compiler is used, unlike `BuildWithNetFrameworkHostedCompiler`.
In most cases, `RoslynUseSdkCompiler=true` is the default setting.
The `RoslynCompilerType` property controls the version of the C# or Visual Basic compiler. The following values are recognized:

### RoslynUseMSBuildCompiler

`RoslynUseMSBuildCompiler=true` can be used to opt out of an implicit `RoslynUseSdkCompiler=true`.
- `Core`: Use the compiler that comes with the .NET SDK. This is the default since .NET 10, even when using .NET Framework MSBuild.
- `Framework`: Use the compiler that comes with .NET Framework MSBuild.
- `FrameworkPackage`: When using .NET Framework MSBuild, download and use a package with the .NET Framework compiler that corresponds to the .NET SDK version.

## Default item inclusion properties

Expand Down