.net - 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 文件异常(exception)。)

Answer 1

使用命名空间级别抑制:

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

namespace MyNamespace
{

}