CA1515：考虑将公共类型变为内部

  • 项目
属性 值
规则 ID CA1515
标题 考虑在内部创建公共类型
类别 可维护性
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 否

原因

可执行程序集中的类型声明为公共类型。

规则说明

与类库不同，应用程序的 API 通常不会公开引用，因此可以将类型标记为 internal。

反过来，内部类型也可以受益于面向非公共 API 的各种代码分析器。

如何解决冲突

将类型标记为 internal。

示例

以下代码片段显示了违反 CA1515 的情况：

// Inside a project with <OutputKind>Exe</OutputKind>
public class Program
{
    public static void Main(string[] args)
    {
    }
}

Public Class Program
    Public Shared Sub Main(args As string())
    End Sub
End Class

以下代码片段修复了冲突：

// Inside a project with <OutputKind>Exe</OutputKind>
internal class Program
{
    public static void Main(string[] args)
    {
    }
}

Friend Class Program
    Public Shared Sub Main(args As string())
    End Sub
End Class

何时禁止显示警告

如果不在乎代码的可维护性，可安全地禁止显示此规则的冲突。

抑制警告

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

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

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

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

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