ReSharper - как отключить генерацию заголовков мусорной документации в Code Cleanup - PullRequest
8 голосов
/ 17 ноября 2011

Мы используем ReSharper 6.0 с StyleCop для ReSharper.

Хотя мы используем правило StyleCop, согласно которому члены должны иметь заголовки документации, мы не хотим, чтобы средство очистки кода ReSharper генерировало для нас заголовки документации, потому что они неизбежно являются мусором. Заголовки плохих документов вообще хуже, чем ничего, потому что они реже обновляются, чем добавляются в первую очередь.

Мы попытались отключить параметр «Вставить текст в документацию и заголовки файлов» в ReSharper => Параметры => Инструменты => StyleCop, но он чертовски сбрасывается при перезапуске Visual Studio.

Есть идеи, как мы можем остановить Code Cleanup, создав для нас заголовки документации?

Ответы [ 2 ]

8 голосов
/ 17 ноября 2011

ReSharper -> Options -> Tools section -> Code Cleanup -> select StyleCop profile -> Documentation section -> untick 1600.

Запретит создание заголовков документации по умолчанию, но StyleCop по-прежнему будет принудительно устанавливать их там.

0 голосов
/ 17 сентября 2015

Второй шаг после блокировки генерации кода - удаление мусора.Я использовал поиск / замену регулярных выражений через visual studio.

Регулярное выражение для заголовка:

// ---.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n.*\r\n\/\/.-{116}

Регулярное выражение для удаления сгенерированных сводок

\s{4}\/\/\/\s<summary>(.*)\r\n.*\r\n.*</summary>

Внимание: оно удалитВСЕ резюме, даже хорошие, поэтому проверьте область замены перед ее запуском.(Git Checkout может быть вашим другом ...)

...