c# - 当方法具有属性时，StyleCop SA1623 是否会错误触发？

Question

我正在触发多个 SA1623: PropertySummaryDocumentationMustMatchAccessors 实例在我的代码中，我有一个类似于此的属性:

    /// <summary>
    /// Gets or Sets the location to check for files.
    /// </summary>
    [Required]
    public string SourceDirectory { get; set; }

这是在 MSBuild Custom Task 中使用的代码图书馆和有问题的属性是 Microsoft.Build.Framework.RequiredAttribute如果这有任何意义。

我正在使用 StyleCop 4.7.14.0不修改默认规则。快速搜索 StackOverflow、Google 和项目的未解决问题日志和文档显示没有提到这个怪癖，我做错了什么这是一个错误吗？

谢谢。

Answer 1

我对这种类型的错误感到非常头疼，并且无法凭直觉知道它们的真正含义:

Severity Code Description Project File Line Suppression State Error SA1623 : CSharp.Documentation : The property's documentation summary text must begin with: Gets or sets a value indicating whether

我明白了，在查看我的代码时，我写得很好，我以“Get 或 sets ...”开始我的总结，但仍然不断出现错误

在几乎发疯之后，我意识到这是针对 2 个 bool 值 属性显示的，而他们告诉我的是，对于 bool 值属性，我实际上应该写出整个句子的字面意思，以“获取或设置一个值指示是否...” 以及我的属性(property)所做的任何事情开始。

例如:

/// <summary> /// 
/// Gets or sets a value indicating whether the product is active. 
/// </summary> 
public boolean Active { get; set; }

我希望这可以节省其他人的时间。