Zmuszanie nazwane argumenty w C#

Question

C# 4 wprowadzono funkcję o nazwie named arguments co jest szczególnie przydatne w sytuacjach jak

int RegisterUser(string nameFirst, string nameLast, string nameMiddle, string email) 

Czy istnieje sposób, aby wymusić za pomocą nazwanych argumentów? Może jakiś atrybut do zastosowania do metody lub przełącznika kompilatora, którego nie jestem świadomy? Myślę, że można to zrobić za pomocą narzędzi inspektora kodu, ale chcę tylko wiedzieć, czy jest inny sposób.

p.s.

Dla zainteresowanych, dlaczego ktoś może go potrzebować i dlaczego nie wystarczy użyć klasy/struktury do wykorzystania object initializers istnieją scenariusze, gdy jest to niemożliwe. Podobnie jak w przypadku połączeń z bibliotekami, które nie są kontrolowane lub nie są zgodne z dziwnymi kodami, musisz się do nich stosować.

Answer 1

Nie, nie w języku C#. Zawsze będzie akceptował parametry pozycyjne, jeśli wszystkie parametry zostaną dostarczone.

Możesz wymusić build a custom FxCop rule lub StyleCop rule, aby to wymusić - jak podkreślono w komentarzach, jest to prawdopodobnie reguła StyleCop, którą chciałbyś (dzięki Krisowi).

Answer 2

Możliwe jest zmuszanie dzwoniących do używania zawsze nazwanych argumentów. Nie zrobiłbym tego w większości przypadków, ponieważ jest to dość brzydkie, ale zależy to od tego, jak bardzo bezpieczne jest użycie metody.

Tutaj rozwiązanie:

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

Pierwszym parametrem jest obojętne, które nie powinny być stosowane (i zestawiane daleko w wersji dla zwiększenia wydajności). Zapewnia jednak, że wszystkie następujące parametry muszą być nazwane.

Ważny jest użycie dowolnej kombinacji wymienionych parametrów:

RegisterUser(); 
    RegisterUser(nameFirst: "Joe"); 
    RegisterUser(nameFirst: "Joe", nameLast: "Smith"); 
    RegisterUser(email: "joe.smith@example.com"); 

Podczas próby użycia parametrów pozycyjnych, kod nie zostanie skompilowany.

Answer 3

Szukałem również sposobu na wymuszenie nazwanych argumentów. Parametry opcjonalne mogą być niebezpieczne, zwłaszcza jeśli masz wiele parametrów tego samego typu. Przeciążenia są prawie zawsze bezpieczniejszym rozwiązaniem, ale zdarzają się sytuacje, w których istnieje metoda, która może przyjmować wiele kombinacji argumentów, więc tworzenie 20 przeciążeń w celu uwzględnienia możliwości jest zawsze przesadą.

W sytuacjach ekstremalnych, gdzie niezwykle ważne jest, aby argumenty były nazywane przez cały czas, utworzę klasę argumentów bez zdefiniowanego konstruktora. W twoim przypadku, można to zrobić:

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

nazwać to tak:

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

Można również uprościć to tak:

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

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

... i to zrobić:

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

W ten sposób masz tylko jeden opcjonalny parametr er i to jest dla twoich opcjonalnych parametrów.

Edytuj: Może nie czytałem poprawnie PO. Nie używasz opcjonalnych argumentów? Jeśli nie, ta odpowiedź prawdopodobnie nie pomoże.

Answer 4

Używam innej metody. W moim setupie mam 1 parametr, którego zawsze oczekuję, a następnie kilka ciągów opcjonalnych, które naprawdę chcę mieć pewność, że użytkownik aktywnie wybrał. Tak więc mój pierwszy ciąg na tej liście jest wartością "pułapki", która jeśli zostanie ustawiona, powoduje błąd. Tak:

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."); 

    } 

hope you like it :)