Правило форматирования, чтобы между объявлениями членов класса была пустая строка
Micrsoft предоставляет набор настроек кодирования для EditorConfig. Настройки соглашения о кодировании.NET для EditorConfig
Но не могу найти способ создать правило, которое предложит разработчику добавить пустую строку между объявлениями членов класса.
// "Bad" style
public class Order
{
private readonly IRepository _repository;
private readonly IPriceCalculator _priceCalculator;
public Order(IRepository repository, IPriceCalculator priceCalculator)
{
_repostitory = repository;
_priceCalculator = priceCalculator;
}
public CopyFrom(Order originalOrder)
{
// Create new order
}
public Cancel(Customer customer)
{
// Cancel order
}
}
// Good style
public class Order
{
private readonly IRepository _repository;
private readonly IPriceCalculator _priceCalculator;
public Order(IRepository repository, IPriceCalculator priceCalculator)
{
_repostitory = repository;
_priceCalculator = priceCalculator;
}
public CopyFrom(Order originalOrder)
{
// Create new order
}
public Cancel(Customer customer)
{
// Cancel order
}
}
1 ответ
Параметры соглашения о кодировании Visual Studio .NET для EditorConfig не предоставляют настройки стиля кода для этого, равно как и сам EditorConfig.
Таким образом, используя только EditorConfig, невозможно создать такое правило.
Вы можете рассмотреть возможность использования StyleCop для этого.
StyleCop был первоначально разработан Microsoft. Инструмент реализует рекомендации по стилю кода, как Microsoft определил их для языка C#. Сейчас разработка продолжается с открытым исходным кодом.
StyleCop доступен как анализатор кода (например, через этот пакет NuGet), так что вы даже можете настроить его для своих проектов и решений независимо. Конечно, вы можете сохранить конфигурацию в своих репозиториях, чтобы синхронизировать настройки всех разработчиков. Конфигурация хранится в .ruleset
файл, формат файла изначально поддерживается Visual Studio.
Вы также можете использовать StyleCop в качестве расширения Visual Studio (StyleCop Classic), но я бы не рекомендовал это делать.
Для вашего случая использования правило SA1513 представляет интерес.
причина
Закрывающая фигурная скобка в элементе, выражении или выражении C# не сопровождается пустой строкой.
В общем, в StyleCop существует множество правил, которые улучшают читабельность и структуру кода. Вы можете выбрать те правила, которые соответствуют вашим потребностям.