命名空间与文件夹结构不匹配 (IDE0130)

属性
规则 ID IDE0130
标题 命名空间与文件夹结构不匹配
类别 Style
Subcategory 语言规则(表达式级首选项)
适用的语言 C# 和 Visual Basic
选项 dotnet_style_namespace_match_folder

概述

此样式规则使用项目的文件夹结构来强制实施命名空间命名要求。

选项

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

dotnet_style_namespace_match_folder

属性 说明
选项名称 dotnet_style_namespace_match_folder
选项值 true 首选命名空间命名以匹配文件夹结构。
false 禁用规则。
默认选项值 true

注意

dotnet_style_namespace_match_folder 选项取决于了解当前项目和根命名空间属性。 此信息由 Visual Studio 提供,但不可用于命令行生成,例如 dotnet build。 若要使命令行生成正常工作,必须将以下属性添加到项目文件:

<ItemGroup>
  <CompilerVisibleProperty Include="RootNamespace" />
  <CompilerVisibleProperty Include="ProjectDir" />
</ItemGroup>

示例

假设以下代码片段来自名为 Data/Example.csData/Example.vb的文件,其中 Data 表示项目文件中的文件夹结构。 文件夹结构命名将添加到根命名空间(在此示例中为 Root)。

// Code with violations
namespace Root.BadExample
{
    class Example
    {
        public void M()
        {
        }
    }
}

// Fixed code
namespace Root.Data
{
    class Example
    {
        public void M()
        {
        }
    }
}
' Code with violations
Namespace Root.BadExample
    Class Example
        Public Sub M()
        End Sub
    End Class
End Namespace

' Fixed code
Namespace Root.Data
    Class Example
        Public Sub M()
        End Sub
    End Class
End Namespace

抑制警告

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

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

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

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

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

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

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

请参阅