Global.asax.cs 文件和 StyleCop 规则 SA1649 存在问题

Question

目前我正在开发一个项目，我们正在考虑将 StyleCop 从版本 4.3.3 升级到 4.5

在这一切的乐趣中，我们遇到了规则 SA1649 - “FileHeaderFileNameDocumentationMustMatchTypeName”，这一切都很好，而且，但会导致 Global.asax.cs 文件出现问题，因为该文件

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="Global.asax.cs" company="COMPANY">
//   Copyright (c) COMPANY. All rights are reserved.....
// </copyright>
// <summary>
//   Starting point for back office website.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Foo.Web
{
    /// <summary>
    /// Starting point for back office website.
    /// </summary>
    public class MvcApplication : HttpApplication
    {
        ....
    }
}

因文件名“Global.asax.cs”和类而受到投诉“MvcApplication”不匹配。我们尝试在 sylecop 设置中放置“Global.asax.cs”的抑制列表，但这似乎不起作用。 （目前我们的解决方法是完全禁用该规则，但我们不想保持这种情况，我们只希望 Global.asax.cs 文件例外。）

Answer 1

使用命名空间级别抑制：

[module: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:FileHeaderFileNameDocumentationMustMatchTypeName", Justification = "Reviewed.")]

namespace MyNamespace
{

}

Answer 2

经过一些时间和对原始工具生成的文件的操作发现了它。

<StyleCopSettings Version="105">
  <Analyzers>
  ... Removed for brevity ...
  </Analyzers>
  <SourceFileList>
        <SourceFile>Global.asax.cs</SourceFile>
        <Settings>
            <Analyzers>
                <Analyzer AnalyzerId="StyleCop.CSharp.DocumentationRules">
                    <Rules>
                        <Rule Name="FileHeaderFileNameDocumentationMustMatchTypeName">
                          <RuleSettings>
                            <BooleanProperty Name="Enabled">False</BooleanProperty>
                          </RuleSettings>
                        </Rule>
                    </Rules>
                </Analyzer>
            </Analyzers>
        </Settings>
    </SourceFileList>
</StyleCopSettings>

希望这可以帮助其他人解决这个问题。