StyleCop - или как соблюдать code style?


codestyle programming StyleCop refactoring

В каждой компании существует свой code style по написанию правильного и красивого кода. Недавно в одном из проектов наша команда решила "причесать" код. На помощь пришел StyleCop. Итак.

Установка

Настройка

Для установки настроек Stylecop одинаковыми на всех ваших проектах нужно выполнить следующие действия:

Разберем каждую вкладку в отдельности

Больше правил и настроек Stylecop вы можете найти на официальном сайте программы. Так же там есть Rule Suppressions, но лучше ими не злоупотреблять.

StyleCop и Build

Если вы хотите запускать StyleCop при каждом билде проекта, вам следует отредактировать .csproj file. В конец файла следует добавить следующую строку (для StyleCop v4.7):

<Import Project="$(ProgramFiles)\MSBuild\StyleCop\v4.7\StyleCop.targets" />

pic_3

После этого вы будете получать Warnings в коде после билда о всех несоответствиях вашего кода с настройками Stylecop. Если вы хотите получать Errors, вам следует добавить в раздел PropertyGroup следующую строку:

<StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>

pic_4