寻找` `protected void Dispose(bool Dispose)`的Stylecop-perfect注释

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中。当然，编辑它只会解决未来项目的问题。

编辑自动生成的代码通常不是最好的想法，但在这种特殊情况下，您将摆脱它。

Answer 2

here有一些很好的评论，但它还没有达到StyleCop兼容的程度。您需要的是：

/// <summary>
/// Releases the unmanaged resources used by this
/// class and optionally releases the managed resources.
/// </summary>
/// <param name="disposing">True to release both managed and unmanaged
/// resources; false to release only unmanaged resources.</param>

希望这能有所帮助！

Answer 3

您可以使用GhostDoc进行调查。它通常会在继承树中进行搜索，并从父类中查找注释。在这种情况下，当Dispose方法被覆盖时，它会找到有意义的注释。