.NET 代码样式分析提供旨在保持代码库中一致 样式 的规则。 这些规则的规则 ID 具有“IDE”前缀。
代码样式规则组织为以下子类别:
-
与 C# 或 Visual Basic 语言相关的规则。 例如,可以指定定义变量时有关使用
var的规则,或有关是否首选 expression-bodied 成员的规则。 此类别还包括查找不必要的代码的规则,例如,方法中无法访问的代码或未使用的私有字段、属性或方法。 -
与代码的布局和结构有关的规则,其作用是使代码更易于阅读。 例如,可以指定一个格式设置选项,用于定义控件块中的空格是否首选。
-
与代码元素命名相关的规则。 例如,可以指定
async方法名必须具有“Async”后缀。 -
不属于其他类别的规则。
索引
下表按 ID 和 选项列出所有代码样式规则(如果有)。
†这些规则是实验性的,可能会更改或删除。
图例
下表显示了参考文档中每个规则提供的信息类型。
| 项 | 说明 |
|---|---|
| 规则 ID | 规则的唯一标识符。 用于在代码文件中配置规则严重性并禁止显示警告。 |
| 标题 | 规则的标题。 |
| 类别 | 规则的类别。 |
| 子类别 | 规则的子类别,例如语言规则、格式规则或命名规则。 |
| 适用的语言 | 适用的 .NET(C# 或 Visual Basic),以及最低语言版本(如果适用)。 |
| 引入的版本 | 首次引入规则时 .NET SDK 或 Visual Studio 的版本。 |
| 选项 | 规则的任何可用选项。 |