“var”首选项(IDE0007 和 IDE0008)
本文介绍两个相关规则,IDE0007
和 IDE0008
。
财产 | 价值 |
---|---|
规则 ID | IDE0007 |
标题 | 使用 var 而不是显式类型 |
类别 | 样式 |
子类别 | 语言规则 ('var' 首选项) |
适用的语言 | C# |
选项 | csharp_style_var_for_built_in_types |
csharp_style_var_when_type_is_apparent |
|
csharp_style_var_elsewhere |
财产 | 价值 |
---|---|
规则 ID | IDE0008 |
标题 | 用显式类型代替 var |
类别 | 样式 |
子类别 | 语言规则 ('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 |
首选显式类型而不是 var 来声明具有内置系统类型的变量,例如 int |
|
默认选项值 | 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
有关详细信息,请参阅 如何取消代码分析警告。