EditorConfig 控制文件范围的命名空间声明

Question

我正在使用 C# 10 新功能File-scoped namespace declaration。

我有这样的旧代码

namespace SampleCode
{
    public class MyClass
    {
    }
}

我正在将此代码移至

namespace SampleCode;

public class MyClass
{
}

但我有很多警告：IDE0160: Convert to block scoped namespace

我如何确保人们只会收到旧语法的警告？

Answer 1

要控制 editorconfig 中的代码样式，请使用以下行：

为了强制执行这种风格

namespace SampleCode
{
    public class MyClass
    {
    }
}

添加这一行.editorconfig

# IDE0160: Convert to block-scoped namespace
csharp_style_namespace_declarations = block_scoped:warning

为了强制执行这种风格

# IDE0160: Convert to block-scoped namespace
csharp_style_namespace_declarations = block_scoped:warning

添加这一行.editorconfig

# IDE0160: Convert to file-scoped namespace
csharp_style_namespace_declarations = file_scoped:warning

Answer 2

更新2022-01-27（所有场景设置）

从版本 2021.3.2 开始，JetBrains Rider 支持 dotnet_diagnostic.IDE* 语法。
这将所有可能场景的设置简化为：

编辑器配置

csharp_style_namespace_declarations = file_scoped:error
dotnet_diagnostic.IDE0161.severity = error

CS项目

csharp_style_namespace_declarations = file_scoped:error
dotnet_diagnostic.IDE0161.severity = error

这将涵盖所有场景。原答案如下。还是值得一读的。

您应该根据所需的状态、使用的 IDE 和工作流程来控制多种不同的设置。

本文对它们进行了描述，我强烈建议您在开始构建项目之前阅读该文章。.editorconfig

以下分别是文件范围和块范围使用的摘要。

用于文件范围使用的 EditorConfig/CSproj 设置

Visual Studio（违规错误）

编辑器配置

csharp_style_namespace_declarations = file_scoped
dotnet_diagnostic.IDE0161.severity = error

笔记

语法迟早option = rule:severity会被弃用。

JetBrains Rider（违规错误）

编辑器配置

csharp_style_namespace_declarations = file_scoped:error

笔记

Rider 不支持 dotnet_diagnostic.IDE* 语法。

CLI 构建，例如 CI/CD 管道

编辑器配置

csharp_style_namespace_declarations = file_scoped
dotnet_diagnostic.IDE0161.severity = error

CS项目

<PropertyGroup>
  <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
</PropertyGroup>

推荐设置

编辑器配置

csharp_style_namespace_declarations = file_scoped:error
dotnet_diagnostic.IDE0161.severity = error

CS项目

csharp_style_namespace_declarations = file_scoped
dotnet_diagnostic.IDE0161.severity = error

笔记

当前的 .NET EditorConfig 语法是否混乱？确实。

用于块范围使用的 EditorConfig/CSproj 设置

Visual Studio（违规错误）

编辑器配置

csharp_style_namespace_declarations = block_scoped
dotnet_diagnostic.IDE0160.severity = error

笔记

语法迟早option = rule:severity会被弃用。

JetBrains Rider（违规错误）

编辑器配置

csharp_style_namespace_declarations = block_scoped:error

笔记

Rider 不支持 dotnet_diagnostic.IDE* 语法。

CLI 构建，例如 CI/CD 管道

编辑器配置

csharp_style_namespace_declarations = block_scoped
dotnet_diagnostic.IDE0160.severity = error

CS项目

csharp_style_namespace_declarations = file_scoped:error

推荐设置

编辑器配置

csharp_style_namespace_declarations = block_scoped:error
dotnet_diagnostic.IDE0160.severity = error

CS项目

csharp_style_namespace_declarations = file_scoped
dotnet_diagnostic.IDE0161.severity = error