Принудительное использование именованных аргументов в C#

Нет, не на языке C#. Он всегда будет принимать позиционные параметры, если все параметры предоставлены.

Вы можете создать собственное правило FxCop или правило StyleCop для обеспечения соблюдения этого - как указано в комментариях, скорее всего, правило StyleCop вас заинтересует. in (спасибо Крису).

Можно заставить вызывающую сторону всегда использовать именованные аргументы. Я бы не стал этого делать в большинстве случаев, потому что это довольно уродливо, но это зависит от того, насколько сильно требуется безопасное использование метода.

Вот решение:

    int RegisterUser(
#if DEBUG
      int _ = 0,
#endif
      string nameFirst = null,
      string nameLast = null,
      string nameMiddle = null,
      string email = null) { /*...*/ }

Первый параметр — это фиктивный параметр, который не следует использовать (он для эффективности компилируется в Release). Однако это гарантирует, что все следующие параметры должны быть названы.

Допустимым использованием является любая комбинация именованных параметров:

    RegisterUser();
    RegisterUser(nameFirst: "Joe");
    RegisterUser(nameFirst: "Joe", nameLast: "Smith");
    RegisterUser(email: "[email protected]");

При попытке использовать позиционные параметры код не будет компилироваться.

Извините за бессовестную затычку!
Я реализовал анализатор Roslyn для обеспечения использование именованных аргументов для метода.

Поэтому, если вы установите анализатор RequireNamedArgs и добавите специальный комментарий перед методом, который должен вызываться с именованными аргументами:

//[RequireNamedArgs]
int RegisterUser(string nameFirst, string nameLast, string nameMiddle, string email)

Анализатор выдаст ошибку, если вызывающая сторона попытается использовать позиционные аргументы вместо именованных.

Посмотрите на это в действии:

Если решите попробовать - делайте это на свой страх и риск :)

Я также искал способ заставить именованные аргументы. Необязательные параметры могут быть опасны, особенно если у вас есть несколько параметров одного типа. Перегрузки почти всегда являются более безопасным решением, но бывают случаи, когда у вас есть метод, который может принимать множество комбинаций аргументов, поэтому создание 20 перегрузок для учета любой возможности — это излишество.

В экстремальных ситуациях, когда крайне важно, чтобы аргументы всегда назывались, я создам класс аргументов без определенного конструктора. В вашем случае вы можете сделать это:

public class UserRegistrationArguments
{
    public string nameFirst { get; set; }
    public string nameLast { get; set; }
    public string nameMiddle { get; set; }
    public string email { get; set; }
}

Назовите это так:

RegisterUser(new UserRegistrationArguments { nameFirst = "Bob", nameLast = "Slob" });

Вы также можете упростить его следующим образом:

public class UserRegistrationArguments
{
    public string nameMiddle { get; set; }
    public string email { get; set; }
}

int RegisterUser(string nameFirst, string nameLast, UserRegistrationArguments args = null)

... и сделать это:

RegisterUser("Bob", "Slob", new UserRegistrationArguments { nameMiddle = "Teh" }); 

Таким образом, у вас есть только один необязательный параметр, и это для ваших необязательных параметров.

Редактировать: Возможно, я неправильно прочитал ОП. Вы не используете необязательные аргументы? Если нет, то этот ответ, вероятно, вам не поможет.

Я использую другой метод. В моей настройке у меня есть 1 параметр, который я всегда ожидаю, затем идет куча необязательных строк, которые я действительно хочу убедиться, что пользователь выбрал активно. Итак, моя первая строка в этом списке — это значение «ловушка», которое, если установлено, выдает ошибку. Нравится:

    public HtmlString Toolbar(DynamicEntity target = null, string dontRelyOnParameterOrder = Constants.RandomProtectionParameter, string actions = null, string contentType = null, object prefill = null)
    {
        if (!Enabled) return null;
        protectAgainstMissingParameterNames(dontRelyOnParameterOrder);

        var toolbar = new ItemToolbar(target, actions, contentType, prefill);

        return new HtmlString(toolbar.Toolbar);
    }

    private void protectAgainstMissingParameterNames(string criticalParameter)
    {
        if(criticalParameter != Constants.RandomProtectionParameter)
            throw new Exception("when using the toolbar command, please use named parameters - otherwise you are relying on the parameter order staying the same.");

    }

Надеюсь, вам понравится :)