Как сделать длинный список параметров доступным для чтения?

Question

Я разработал естественное отвращение к длинным спискам параметров в функциях. Хотя это в какой-то мере хорошо, иногда длинные списки параметров являются меньшим из двух зол по сравнению с дублированием кода или смехотворно длинными функциями из-за «ручной вставки». Какой хороший способ, по крайней мере, сделать некоторые из этих чудовищ удобочитаемыми человеком? Например:

SomeClass[string] someFunction(SomeClass!(TemplateParam) foo, 
    string[][string] someAA, uint[] dataToProcess, SomeEnumType flag) { 
    // Do stuff. 
} 

Это не очень высокое значение по шкале читаемости, но во многих случаях четыре параметра довольно разумны.

Answer 1

Для такого рода ситуации, я, как правило, форматировать его, как это:

SomeClass[string] someFunction(
    SomeClass!(TemplateParam) foo, 
    string[][string] someAA, 
    uint[] dataToProcess, 
    SomeEnumType flag 
) 
{ 
    // Do stuff. 
} 

Answer 2

I перегруппировать параметры в (главным образом внутреннем) классе (или структуру), чтобы избежать большого объявления функции/называем

Answer 3

Мне нравится ответ Аарона, просто давая новую строку для каждого параметра.

Когда это становится слишком большим, то пришло время немного реорганизовать.

Если у вас еще необходимо, чтобы у вас было много параметров, переключитесь на передачу в классе, который вместо этого обернет ваши свойства. Затем вы получаете дополнительный бонус, который легко добавляет дефолтные параметры к вашему методу, а также не подталкивает вашу подпись.

Answer 4

• для удобочитаемости - ставить каждый аргумент на новой линии
• ради практичности и лучше API Desgin - аргументы, связанные группы в новые классы, тем самым сокращая количество аргументов.

Answer 5

Вы можете ввести объект параметра:

class ParameterObject { 
    public final SomeClass!(TemplateParam) foo; 
    public final string[][string] someAA; 
    public final uint[] dataToProcess; 
    public final SomeEnumType flag; 

    private ParameterObject(
     SomeClass!(TemplateParam) foo, 
     string[][string] someAA, 
     uint[] dataToProcess, 
     SomeEnumType flag) { 
     this.foo = foo; 
     this.someAA = someAA; 
     this.dataToProcess = dataToProcess; 
     this.flag = flag; 
    } 

    private static class Builder { 
     public SomeClass!(TemplateParam) foo; 
     public string[][string] someAA; 
     public uint[] dataToProcess; 
     public SomeEnumType flag; 

     public Builder foo(SomeClass!(TemplateParam) foo) { 
      this.foo = foo; 
      return this; 
     } 

     public Builder someAA(string[][string] someAA) { 
      this.someAA = someAA; 
      return this; 
     } 

     public Builder dataToProcess(uint[] dataToProcess) { 
      this.dataToProcess = dataToProcess; 
      return this; 
     } 

     public Builder flag(SomeEnumType flag) { 
      this.flag = flag; 
      return this; 
     } 

     public ParameterObject build() { 
      if (null == foo) throw Exception("init foo!"); 
      if (null == someAA) throw Exception("init someAA!"); 
      if (null == dataToProcess) throw Exception("init dataToProcess!"); 
      if (null == flag) throw Exception("init flag!"); 
      return new ParameterObject(foo, someAA, dataToProcess, flag); 
     } 
    } 
} 

Теперь, ваш звонок будет выглядеть, например:

SomeClass[string] myValue = 
    someFunction(
     new ParameterObject.Build(). 
      foo(myFoo). 
      someAA(myAA). 
      dataToProcess(myData). 
      flag(false). 
      build() 
    ); 

Это гораздо легче иметь дело с подобными случаями на языках, которые позволяют создавать инлайн карты:

someFunction(
    Map.new(
     foo => myFoo, 
     someAA => myAA, 
     dataToProcess => myData, 
     flag => false 
    ) 

Отборочный код final означает, что поле может быть установлено только из конструктора класса. Квалификатор static перед классом означает, что класс не привязан к его внешнему классу, то есть не может получить доступ к нему или изменить его поля.