使用 StyleCop 样式
在 C# 中,JetBrains Rider 可以根据 StyleCop 规则应用其 代码格式化和 代码语法样式。 以下是 JetBrains Rider 支持 StyleCop 的几种方式。
为了应用 StyleCop 规则,JetBrains Rider 依赖于其自身的功能和设置,这些功能和设置并不总是能直接映射到 StyleCop 规则上:
JetBrains Rider 支持大多数 StyleCop 的命名、可维护性、可读性和布局规则。
某些 StyleCop 规则可能在特定版本的 JetBrains Rider 中不受支持。 然而,我们将在未来版本中尝试支持更多规则。
StyleCop 规则的检查
JetBrains Rider 提供了许多针对 格式化和 语法样式规则的代码检查。 这些检查无法发现 StyleCop 找到的所有代码样式问题,但它们也可以发现一些 StyleCop 无法发现的问题,例如缩进问题。
从 2018.1 版本开始,格式化检查默认是禁用的,但一旦您 启用 StyleCop 设置 ,它们将自动激活,并为您提供 代码问题的快速修复 自动修正检测到的问题。
从 StyleCop 文件中应用设置
默认情况下,JetBrains Rider 不会从 StyleCop 文件( RuleSet 和 Settings.StyleCop )中读取设置。 若要开始考虑这些设置,请在 JetBrains Rider 设置 Ctrl+Alt+S 的 页面上选择 启用 StyleCop 支持 复选框,并选择应使用的 StyleCop 文件格式。 请确保在 JetBrains Rider 设置 的 页面上选择了 从 editorconfig、项目设置和规则集中读取设置。
启用 StyleCop 集成时,StyleCop 配置文件( RuleSet 和 Settings.StyleCop )中的设置将覆盖 JetBrains Rider 的 代码格式化 和 代码语法 样式,并启用相应的代码检查。
如果您的项目中安装了 StyleCop.Analyzers NuGet 包,JetBrains Rider 还会读取并应用 StyleCop Analyzers 样式的默认值。 这些值将优先于 JetBrains Rider 设置中的相应样式,但如果有配置文件中的值,它们将被覆盖。
如果您同时使用 EditorConfig 和 StyleCop 配置文件,StyleCop 设置将始终优先于 EditorConfig 属性 和 JetBrains Rider 设置。
使用 StyleCop.Analyzers
在代码中应用 StyleCop 规则的另一种方法是使用 适用于 .NET 编译器平台的 StyleCop Analyzers 而不是 StyleCop。 要利用这些分析器,请在 JetBrains Rider 中启用 .NET 编译器平台分析器 ,然后安装相应的分析器包。