c# - 寻找 `protected override void Dispose(bool disposing)` 的 Stylecop 完美评论

Question

我知道，StyleCop 并不完美，但我们尝试以有用的方式使用它。我确实喜欢它提示未记录的论点这一事实。现在，对于属性和构造函数，它建议文本应该是什么，但它对 Dispose 方法没有帮助，我认为它应该。我们有许多实现 IDisposable 的类。在这种特殊情况下，该类是 WinForm。问题是我没能为 Dispose 方法提供很好的文档，而且我也没有在网上看到好的示例。许多例子没有任何评论。我希望那些觉得 Dispose 方法是他们的第二天性的人可以帮我一劳永逸地记录下来，这样我就可以在任何地方重复使用这个评论。

这是我们拥有的:

    /// <summary>
    /// Clean up any resources being used.
    /// </summary>
    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            if (this.components != null)
            {
                this.components.Dispose();
            }
        }

        base.Dispose(disposing);
    }

这是警告信息:

Warning 15 SA1611: The documentation header must contain param tags matching the element's parameter list.  

我希望其他 So 用户也会发现这个问题的答案有帮助。 如果您有任何问题，请告诉我。

Answer 1

这是从项目模板自动生成的代码。唯一真正的解决方法是更改​​模板或编辑 Designer.cs 源代码文件。该模板在 Common7\IDE\ItemsTemplate(Cache)\CSharp\Windows Forms\xxxx\Form.zip\form.designer.cs 中。编辑它当然只会解决 future 项目的问题。

编辑自动生成的代码通常不是最好的主意，但在这种特殊情况下你会逃脱它。