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

Question

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

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

这是MSBuild 自定义任务库中使用的代码，相关属性是Microsoft.Build.Framework.RequiredAttribute（如果有任何含义）。

我使用的是StyleCop 4.7.14.0，没有对默认规则进行任何修改。快速搜索 StackOverflow、Google 以及项目的 Open Issue 日志和文档，没有发现任何提及此怪癖的情况，我是否做错了什么，这是一个错误吗？

谢谢。

Answer 1

我对这种类型的错误感到非常头疼，并且不直观地知道它们的真正含义：

严重性代码 描述 项目文件行抑制状态错误 SA1623 : CSharp.Documentation : 属性的文档摘要文本必须以以下内容开头： 获取或设置一个值，该值指示是否

我得到了这一点，当查看我的代码时，我写得很好，我以“获取或设置...”开始我的摘要，但仍然不断收到错误

几乎要疯了之后，我意识到这是针对 2 个布尔属性显示的，他们告诉我的是，对于布尔属性，我实际上应该写整个句子，从“获取或设置一个值指示是否...”开始，然后无论我的财产做什么。

例如：

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

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