Ищите комментарии, идеально подходящие для Stylecop для `protected override void Dispose (bool dispose)` - PullRequest
Новая
       13

Ищите комментарии, идеально подходящие для Stylecop для `protected override void Dispose (bool dispose)`

1 голос
/ 06 августа 2010

Я знаю, 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 также найдут ответ на этот вопрос полезным. Дайте мне знать, если у вас есть вопросы.

Ответы [ 3 ]

2 голосов
/ 06 августа 2010

Это автоматически сгенерированный код из шаблона проекта.Единственное реальное исправление - это изменить шаблон или отредактировать файл исходного кода Designer.cs.Шаблон находится в Common7 \ IDE \ ItemsTemplate (Cache) \ CSharp \ Windows Forms \ xxxx \ Form.zip \ form.designer.cs.Редактирование этого, конечно, только исправит проблему для будущих проектов.

Редактирование автоматически сгенерированного кода обычно не самая лучшая идея, но в данном конкретном случае вам это сойдет с рук.

1 голос
/ 10 августа 2010

Вы можете исследовать, используя GhostDoc.Он часто выполняет поиск по дереву наследования и находит комментарии от родительских классов.В этом случае, поскольку метод Dispose переопределен, он найдет значимые комментарии.

1 голос
/ 06 августа 2010

Есть несколько хороших комментариев здесь , но это не так уж далеко, чтобы быть 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>

Надеюсь, это поможет!

...