CA2255:不应在库中使用 ModuleInitializer 属性

属性
规则 ID CA2255
标题 不应在库中使用 ModuleInitializer 属性
类别 使用情况
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 作为警告

原因

向类库中的方法应用 ModuleInitializerAttribute

规则说明

模块初始值设定项旨在由应用程序代码使用,以确保在应用程序代码开始执行之前初始化应用程序的组件。 如果库代码使用 ModuleInitializerAttribute 声明方法,则它可能会干扰应用程序初始化,也可能导致该应用程序的剪裁能力受到限制。 因此,库代码不得使用 ModuleInitializerAttribute 属性。

如何解决冲突

库应公开可用于初始化库中的任何组件的方法,并允许应用程序在应用程序初始化期间调用方法,而不是使用标记为 ModuleInitializerAttribute 的方法。

何时禁止显示警告

如果解决方案出于代码分解目的使用类库,并且 ModuleInitializerAttribute 方法不是共享或分布式库或包的一部分,那么可安全地禁止显示此规则发出的警告。

抑制警告

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

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

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

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

若要禁用此整个规则类别,请在配置文件中将此类别的严重性设置为 none

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

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

另请参阅