настройка «игнорировать рядовые» «игнорировать внутренние компоненты» не влияет на внутренние классы и их подэлементы - PullRequest
4 голосов
/ 11 января 2011

По какой-то странной причине StyleCop не соблюдает мои настройки правил документации.Рассмотрим следующий код:

internal class SomeClass
{
    public SomeClass()
    {
    }

    public SomeMethod()
    {
    }

    public SomeProperty { get; set; }
}

И следующие настройки:

<Analyzer AnalyzerId="Microsoft.StyleCop.CSharp.DocumentationRules">
...
    <AnalyzerSettings>
       <BooleanProperty Name="IgnorePrivates">True</BooleanProperty>
       <BooleanProperty Name="IgnoreInternals">True</BooleanProperty>
    </AnalyzerSettings>
</Analyzer>
...

Я получаю следующие сообщения от stylecop 4.4

  • SA1600: класс должениметь заголовок документации.
  • SA1600: у конструктора должен быть заголовок документации.
  • SA1600: метод должен иметь заголовок документации.
  • SA1600: свойство должно иметьЗаголовок документации.

Это ошибка или функция?Не следует ли игнорировать внутренние классы?

1 Ответ

1 голос
/ 07 марта 2011

Если вы используете Stylecop из Visual Studio, проверьте, отмечены ли ваши настройки в разделе Настройки StyleCop -> Правила документации, в противном случае ваши настройки могут перезаписаться во время выполнения.

...