Skip to content

Add a note describing feature switches as last resort option #11394

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add a note describing feature switches as last resort option #11394

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffc0d60
Add a note describing feature switches as last resort option
MichalStrehovsky Jun 3, 2025
431f928
Update FeatureSwitchDefinitionAttribute.xml
MichalStrehovsky Jun 3, 2025
cbd5fce
Update xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAtt…
MichalStrehovsky Jun 5, 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
12 changes: 9 additions & 3 deletions xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,15 @@
corresponds to the feature switch specified by name.</para>
</summary>
<remarks>
<para>
IL rewriters and compilers can use this attribute to substitute the return value
of the specified property with the value of the feature switch.</para>
<format type="text/markdown"><![CDATA[
IL rewriters and compilers can use this attribute to substitute the return value of the specified property with the value of the feature switch.

The value of the feature switch can only be specified at the application level and affects the entire application. It is possible to get into situations where one library that is part of the application requires the feature switch to be turned on, but has no way to communicate this to the application author.

Feature switches complicate unit testing and code sharing since different application configurations might have different values of the feature switch, and it's difficult to ensure all code paths work as expected.

It is therefore preferable to structure APIs in a way that trimming can happen naturally without any feature switches. The use of feature switches should be reserved for situations where trimming needs to happen, but it's not feasible to change the APIs to allow trimming naturally.
]]></format>
</remarks>
<example>
<format type="text/markdown"><![CDATA[
Expand Down