“var”首选项(IDE0007 和 IDE0008)
本文介绍了两个相关的规则:IDE0007
和 IDE0008
。
属性 | 值 |
---|---|
规则 ID | IDE0007 |
标题 | 用 var 替代显式类型 |
类别 | Style |
Subcategory | 语言规则(“var”首选项) |
适用的语言 | C# |
选项 | csharp_style_var_for_built_in_types |
csharp_style_var_when_type_is_apparent |
|
csharp_style_var_elsewhere |
属性 | 值 |
---|---|
规则 ID | IDE0008 |
标题 | 用显式类型代替 var |
类别 | Style |
Subcategory | 语言规则(“var”首选项) |
适用的语言 | C# |
选项 | csharp_style_var_for_built_in_types |
csharp_style_var_when_type_is_apparent |
|
csharp_style_var_elsewhere |
概述
这两个样式规则定义变量声明中是否应使用 var 关键字或某个显式类型。 若要强制使用 var
,请将 IDE0007
的严重性设置为警告或错误。 若要强制使用显式类型,请将 IDE0008
的严重性设置为警告或错误。
选项
此规则的关联选项定义应当应用此样式首选项的位置:
- 内置类型 (csharp_style_var_for_built_in_types)
- 该类型显而易见的位置 (csharp_style_var_when_type_is_apparent)
- 其他位置 (csharp_style_var_elsewhere)
若要详细了解如何配置选项,请参阅选项格式。
csharp_style_var_for_built_in_types
属性 | 值 | 说明 |
---|---|---|
选项名称 | csharp_style_var_for_built_in_types | |
选项值 | true |
对于 int 之类的内置系统类型,优先使用 var 来声明变量 |
false |
对于 int 之类的内置系统类型,优先使用显式类型而非 var 来声明变量 |
|
默认选项值 | false |
// csharp_style_var_for_built_in_types = true
var x = 5;
// csharp_style_var_for_built_in_types = false
int x = 5;
csharp_style_var_when_type_is_apparent
属性 | 值 | 说明 |
---|---|---|
选项名称 | csharp_style_var_when_type_is_apparent | |
选项值 | true |
当声明表达式的右侧已提到该类型时,优先使用 var |
false |
当声明表达式的右侧已提到该类型时,优先使用显式类型 | |
默认选项值 | false |
// csharp_style_var_when_type_is_apparent = true
var obj = new Customer();
// csharp_style_var_when_type_is_apparent = false
Customer obj = new Customer();
csharp_style_var_elsewhere
属性 | 值 | 说明 |
---|---|---|
选项名称 | csharp_style_var_elsewhere | |
选项值 | true |
在任何情况下都优先使用 var 而非显式类型,除非被另一个代码样式规则替代 |
false |
在任何情况下都优先使用显式类型而非 var ,除非被另一个代码样式规则替代 |
|
默认选项值 | false |
// csharp_style_var_elsewhere = true
var f = this.Init();
// csharp_style_var_elsewhere = false
bool f = this.Init();
抑制警告
如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。
#pragma warning disable IDE0007 // Or IDE0008
// The code that's violating the rule is on this line.
#pragma warning restore IDE0007 // Or IDE0008
若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none
。
[*.{cs,vb}]
dotnet_diagnostic.IDE0007.severity = none
dotnet_diagnostic.IDE0008.severity = none
若要禁用所有代码样式规则,请在配置文件中将类别 Style
的严重性设置为 none
。
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
有关详细信息,请参阅如何禁止显示代码分析警告。