试图抑制 StyleCop 消息 SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine

Question

我试图抑制特定属性的以下 StyleCop 消息：

SA1513: Statements or elements wrapped in curly brackets must be followed by a blank line.

我正在尝试执行以下操作，但它似乎不起作用：

    [SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules", "SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine", Justification = "There are no issues with this code")]
    public string CustomerId
    {
        get
        {
            return this.GetProperty(CustomerIdProperty);
        }
        set
        {
            if (this.IsNew)
            {
                this.SetProperty(CustomerIdProperty, value);
            }
            else
            {
                throw new ReadOnlyException("Id value can only be changed for a new record.");
            }
        }
    }

我只是做错了什么吗？或者这是不可能的？这是一个很好的规则，只是对我的财产来说无效。

更新

尝试从 DocumentationRules 切换到 LayoutRules ...仍然没有抑制。

    [DataObjectField(true, false)]
    [SuppressMessage("Microsoft.StyleCop.CSharp.LayoutRules", "SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine", Justification = "There are no issues with this code")]
    public string CustomerId
    {
        get
        {
            return this.GetProperty(CustomerIdProperty);
        }
        set
        {
            if (this.IsNew)
            {
                this.SetProperty(CustomerIdProperty, value);
            }
            else
            {
                throw new ReadOnlyException("Id value can only be changed for a new record.");
            }
        }
    }

Answer 1

我认为这可能是 StyleCop 的问题。您安装的是哪个版本？ 此页面指出：

从 StyleCop 4.3.2 开始，可以通过在源代码中添加抑制属性来抑制规则违规的报告。

我刚刚发现我无法抑制任何消息。我使用的安装程序只提供了 4.3 版本。 Codeplex 上的最新版本是 4.4.0.0。确保您安装了该版本。

更新

我一直在做一些检查，我可以抑制 DocumentationRules:

    [SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules",
                     "SA1600:ElementsMustBeDocumented",
                     Justification = "Reviewed. Suppression is OK here.")]

但不能抑制 SpacingRules 或 LayoutRules。然而，我没有发现任何证据表明为什么会出现这种情况。

Answer 2

您的抑制使用 Microsoft.StyleCop.CSharp.DocumentationRules。我认为它应该是Microsoft.StyleCop.CSharp.LayoutRules。

Answer 3

[SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine", Justification = "There are no issues with this code")]

适用于最新的 StyleCop。刚刚删除了“微软”。前缀。

Answer 4

StyleCop 中有一个错误，让您只能抑制某些类型的规则。该问题将在即将发布的 StyleCop 4.4 中得到修复。

Answer 5

请仔细阅读 StyleCop 文档以了解如何抑制规则。以下内容在我的代码中起作用：

    [SuppressMessage("Microsoft.StyleCop.CSharp.MaintainabilityRules",
    "SA1402:FileMayOnlyContainASingleClass",
    Justification = "Splitting this file into classes would get too confusing.")]

来自帮助文件：

SuppressMessage 属性具有以下格式：

[SuppressMessage("规则类别、"规则 ID"、"理由")]

地点：

• 规则类别 - 在其中定义规则的 StyleCop 规则命名空间。例如，
  Microsoft.StyleCop.CSharp.DocumentationRules

• 规则 ID - 规则的标识符，使用格式短名称:长名称。

  例如，SA1600:ElementsMustBeDocumented

• 理由 - 用于记录禁止原因的文本
  消息。

正如已经提到的，确保您引用正确的规则命名空间。

Answer 6

只需在 get 块和 set 块之间添加一个空行即可。
这就是您所要做的，添加一个空行，问题就解决了。