Чем больше расширяется проект и чем больше разработчиков над ним работают, тем сильнее различается стиль написания кода, не говоря об удобстве его чтения. Для решения такой проблемы был создан StyleCop.
Что это?
StyleCop - open-source инструмент анализа стиля написания кода от Microsoft. Содержит рекомендованные стили и рекомендации для оформления кода.
Правила по которым проверяется ваш код находятся в настройках Visual Studio. Утилита добавляет все некорректные наименования и другие погрешности во вкладку "Предупреждения".
Как установить?
Для установки необходимо перейти по ссылке на установку расширения или установить из Visual Studio.
Для установки через Visual Studio зайдите во вкладку Расширения -> Менеджер разрешений. После открытия менеджера перейдите во вкладку Online и в поиске напишите StyleCop. Нажмите по расширения и на кнопку установить.
После установки необходимо перезагрузить Visual Studio.
Как пользоваться?
Для использования достаточно открыть вкладку "Инструменты" и нажать "Запустить StyleCop". После проверки во вкладке предупреждений будет информация о проблемах стиля кода.
Настройка правил под проект.
StyleCop на данный момент не имеет визуального интерфейса для настроек. Поэтому нужно создавать их в отдельном файле и подключить его. Подробнее по ссылке.
Итог
Удобный инструмент для проверки стиля кода. Большим минусом является не полная интеграция с Visual Studio. Данная утилита не содержит визуального интерфейса для настройки и не интегрирована в IntelliSence.
Телеграмм канал: https://t.me/dotnetreview