Правило форматирования, чтобы между объявлениями членов класса была пустая строка - PullRequest
Новая
       8

Правило форматирования, чтобы между объявлениями членов класса была пустая строка

0 голосов
/ 17 февраля 2019

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 Ответ

0 голосов
/ 28 февраля 2019

Настройки .NET для Visual Studio для EditorConfig не обеспечивают настройки стиля кода, как и EditorConfig .

.Только для EditorConfig, нет никакого способа создать такое правило.

Вы можете рассмотреть возможность использования StyleCop для этого.

StyleCop был первоначально разработан Microsoft.Инструмент реализует рекомендации по стилю кода, как Microsoft определил их для языка C #.Теперь разработка продолжается с открытым исходным кодом.

StyleCop доступен в качестве анализатора кода (например, через этот пакет NuGet ), так что вы даже можете настроить его для своих проектови решения самостоятельно.Конечно, вы можете сохранить конфигурацию в своих репозиториях, чтобы синхронизировать настройки всех разработчиков.Конфигурация хранится в файле .ruleset, формат файла изначально поддерживается Visual Studio.

Вы также можете использовать StyleCop в качестве расширения Visual Studio (StyleCop Classic), но я бы не рекомендовал это делать.

В вашем случае интерес представляет правило SA1513 .

Причина
Закрывающая скобка внутри элемента C #, оператор или выражение не сопровождаются пустой строкой.

В общем, в StyleCop существует множество правил, улучшающих читаемость и структуру кода.Вы можете выбирать те правила, которые соответствуют вашим потребностям.

...