添加 readonly 修饰符 (IDE0044)

属性
规则 ID IDE0044
标题 添加 readonly 修饰符
类别 Style
Subcategory 语言规则(字段首选项)
适用的语言 C# 和 Visual Basic
引入的版本 Visual Studio 2017
选项 dotnet_style_readonly_field

概述

此样式规则涉及为已初始化(以内联方式或在构造函数内部)但从未重新赋值的专用字段指定 readonly (C#)ReadOnly (Visual Basic) 修饰符。

选项

选项指定你希望规则强制实施的行为。 若要了解如何配置选项,请参阅选项格式

dotnet_style_readonly_field

Property 说明
选项名称 dotnet_style_readonly_field
选项值 true 如果专用字段只是内联分配或者在构造函数中,偏向将它们标记为 readonly
false 指定就专用字段是否应标记为 readonly 无偏向
默认选项值 true
// dotnet_style_readonly_field = true
class MyClass
{
    private readonly int _daysInYear = 365;
}
' dotnet_style_readonly_field = true
Public Class MyClass
    Private ReadOnly daysInYear As Int = 365
End Class

抑制警告

如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。

#pragma warning disable IDE0044
// The code that's violating the rule is on this line.
#pragma warning restore IDE0044

若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none

[*.{cs,vb}]
dotnet_diagnostic.IDE0044.severity = none

若要禁用所有代码样式规则,请在配置文件中将类别 Style 的严重性设置为 none

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

有关详细信息,请参阅如何禁止显示代码分析警告

另请参阅