Use conditional expression for return (IDE0046)
Property | Value |
---|---|
Rule ID | IDE0046 |
Title | Use conditional expression for return |
Category | Style |
Subcategory | Language rules (expression-level preferences) |
Applicable languages | C# and Visual Basic |
Introduced version | Visual Studio 2017 |
Options | dotnet_style_prefer_conditional_expression_over_return |
Overview
This style rule concerns the use of a ternary conditional expression versus an if-else statement for return statements that require conditional logic.
Options
Options specify the behavior that you want the rule to enforce. For information about configuring options, see Option format.
dotnet_style_prefer_conditional_expression_over_return
Property | Value | Description |
---|---|---|
Option name | dotnet_style_prefer_conditional_expression_over_return | |
Option values | true |
Prefer return statements to use a ternary conditional |
false |
Prefer return statements to use an if-else statement | |
Default option value | true |
// dotnet_style_prefer_conditional_expression_over_return = true
return expr ? "hello" : "world"
// dotnet_style_prefer_conditional_expression_over_return = false
if (expr)
{
return "hello";
}
else
{
return "world";
}
' dotnet_style_prefer_conditional_expression_over_return = true
Return If(expr, "hello", "world")
' dotnet_style_prefer_conditional_expression_over_return = false
If expr Then
Return "hello"
Else
Return "world"
End If
Suppress a warning
If you want to suppress only a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.
#pragma warning disable IDE0046
// The code that's violating the rule is on this line.
#pragma warning restore IDE0046
To disable the rule for a file, folder, or project, set its severity to none
in the configuration file.
[*.{cs,vb}]
dotnet_diagnostic.IDE0046.severity = none
To disable all of the code-style rules, set the severity for the category Style
to none
in the configuration file.
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
For more information, see How to suppress code analysis warnings.