1

我知道，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 用户也能找到这个有用的答案。如果您有任何问题，请告诉我。

4

3 回答 3

2

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

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

于 2010-08-06T15:58:36.620 回答
2

这里有一些很好的评论，但它并没有达到 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>

希望这可以帮助！

于 2010-08-06T16:09:51.810 回答
1

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

于 2010-08-10T10:15:17.987 回答