Автоматическое разделение временных переменных в Delphi
В этой статье рассматривается правильное использование временных переменных, причины для разделения неправильно используемых переменных, а также способ автоматического разделения с помощью Castalia.
Я хотел бы ответить на вопрос, который мне часто задают люди, видящие Castalia впервые. Когда они просматривают список рефакторингов, они видят такие пункты, как «Extract Method» и «Rename Local Variable», которые говорят сами за себя: по названию можно понять, что они делают. Затем они видят «Split Temporary Variable» и не знают, что об этом думать. Это не очень интуитивный рефакторинг, и в большинстве случаев его игнорируют, несмотря на его исключительную полезность.
Если говорить кратко, этот рефакторинг применяется тогда, когда «у вас есть локальная переменная, которой присваивается значение более одного раза, и она не является переменной цикла или накапливающей переменной» (Мартин Фаулер в книге «Рефакторинг: улучшение существующего кода»).
Локальные переменные используются по-разному. Некоторые из этих способов использования по своей природе требуют, чтобы переменной присваивалось значение более одного раза. Например, переменные цикла изменяются на каждой итерации (как I в конструкции for I := 0 to 10). Накапливающие временные переменные собирают некоторое значение, формируемое в ходе выполнения метода, обычно по шаблону вида «SomeVar := SomeVar + SomeNewValue».
Другие временные переменные используются для хранения результата фрагмента кода с целью удобного обращения к нему в дальнейшем. Такие переменные должны устанавливаться только один раз. Если им присваивается значение более одного раза, это явный признак того, что переменная несёт более одной ответственности в рамках функции или процедуры. Это затрудняет чтение и сопровождение кода, поскольку в каждый конкретный момент сложно понять, какая именно ответственность реализуется. Каждая ответственность должна быть представлена отдельной переменной, что делает код более понятным и удобным в сопровождении.
Именно здесь на помощь приходит рефакторинг «Split Temporary Variable». Он берёт переменную с несколькими обязанностями и разделяет её на отдельные переменные с уникальными обязанностями. Разберём пример:
procedure TForm1.UpdateCoordinates;
var
Temp: Integer;
begin
Temp := Shape1.Top;
StatusBar1.Panels[0].Text := IntToStr(Temp);
Temp := Shape1.Left;
StatusBar1.Panels[1].Text := IntToStr(Temp);
end;
В этом методе панели строки состояния обновляются координатами фигуры. Переменная «Temp» несёт несколько обязанностей в рамках метода: она представляет и значение Top, и значение Left. Мы можем (и должны) разделить эти обязанности.
Чтобы Castalia выполнила это разделение, поместите курсор в имя переменной, которую нужно разделить (подойдёт любое упоминание Temp — просто щёлкните по нему, чтобы курсор оказался внутри слова «Temp»). Выберите «Split Temporary Variable» в меню рефакторинга (либо в контекстном меню редактора, либо в главном меню Edit). Появится диалоговое окно, сообщающее, что мы собираемся разделить переменную Temp типа Integer на две переменные, и предлагающее ввести имя новой переменной. Вводим ShapeLeft в качестве имени новой переменной и нажимаем OK.

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

Нажимаем «GO» (в Castalia 2.2 эта кнопка переименована в «Apply»), и Castalia применит выбранные изменения. Теперь процедура выглядит следующим образом:
procedure TForm1.UpdateCoordinates;
var
Temp, ShapeLeft: Integer;
begin
Temp := Shape1.Top;
StatusBar1.Panels[0].Text := IntToStr(Temp);
ShapeLeft := Shape1.Left;
StatusBar1.Panels[1].Text := IntToStr(ShapeLeft);
end;
Это уже улучшение. Конечно, дополнительный рефакторинг мог бы сделать этот код ещё лучше. Применение «Rename Local Variable» для переименования Temp во что-то вроде ShapeTop стало бы очевидным улучшением. Код можно сделать ещё более лаконичным, использовав «Inline Temporary Variable» для полного устранения переменных.
В этой статье мы узнали о правильном использовании временных переменных и о том, как применять рефакторинг «Split Temporary Variable» в Castalia для улучшения тех мест кода, где мы могли использовать их неправильно. Дополнительную информацию о других рефакторингах Castalia можно найти здесь.
Автоматическое разделение временных переменных в Delphi
Автоматическое разделение временных переменных в Delphi : Несколько тысяч советов, которые сделают вашу жизнь проще.
В этой статье рассматривается правильное использование временных переменных, причины для разделения неправильно используемых переменных, а также способ автоматического разделения с помощью Castalia.
Я хотел бы ответить на вопрос, который мне часто задают люди, видящие Castalia впервые. Когда они просматривают список рефакторингов, они видят такие пункты, как «Extract Method» и «Rename Local Variable», которые говорят сами за себя: по названию можно понять, что они делают. Затем они видят «Split Temporary Variable» и не знают, что об этом думать. Это не очень интуитивный рефакторинг, и в большинстве случаев его игнорируют, несмотря на его исключительную полезность.
Если говорить кратко, этот рефакторинг применяется тогда, когда «у вас есть локальная переменная, которой присваивается значение более одного раза, и она не является переменной цикла или накапливающей переменной» (Мартин Фаулер в книге «Рефакторинг: улучшение существующего кода»).
Локальные переменные используются по-разному. Некоторые из этих способов использования по своей природе требуют, чтобы переменной присваивалось значение более одного раза. Например, переменные цикла изменяются на каждой итерации (как I в конструкции for I := 0 to 10). Накапливающие временные переменные собирают некоторое значение, формируемое в ходе выполнения метода, обычно по шаблону вида «SomeVar := SomeVar + SomeNewValue».
Другие временные переменные используются для хранения результата фрагмента кода с целью удобного обращения к нему в дальнейшем. Такие переменные должны устанавливаться только один раз. Если им присваивается значение более одного раза, это явный признак того, что переменная несёт более одной ответственности в рамках функции или процедуры. Это затрудняет чтение и сопровождение кода, поскольку в каждый конкретный момент сложно понять, какая именно ответственность реализуется. Каждая ответственность должна быть представлена отдельной переменной, что делает код более понятным и удобным в сопровождении.
Именно здесь на помощь приходит рефакторинг «Split Temporary Variable». Он берёт переменную с несколькими обязанностями и разделяет её на отдельные переменные с уникальными обязанностями. Разберём пример:
procedure TForm1.UpdateCoordinates;
var
Temp: Integer;
begin
Temp := Shape1.Top;
StatusBar1.Panels[0].Text := IntToStr(Temp);
Temp := Shape1.Left;
StatusBar1.Panels[1].Text := IntToStr(Temp);
end;
В этом методе панели строки состояния обновляются координатами фигуры. Переменная «Temp» несёт несколько обязанностей в рамках метода: она представляет и значение Top, и значение Left. Мы можем (и должны) разделить эти обязанности.
Чтобы Castalia выполнила это разделение, поместите курсор в имя переменной, которую нужно разделить (подойдёт любое упоминание Temp — просто щёлкните по нему, чтобы курсор оказался внутри слова «Temp»). Выберите «Split Temporary Variable» в меню рефакторинга (либо в контекстном меню редактора, либо в главном меню Edit). Появится диалоговое окно, сообщающее, что мы собираемся разделить переменную Temp типа Integer на две переменные, и предлагающее ввести имя новой переменной. Вводим ShapeLeft в качестве имени новой переменной и нажимаем OK.

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

Нажимаем «GO» (в Castalia 2.2 эта кнопка переименована в «Apply»), и Castalia применит выбранные изменения. Теперь процедура выглядит следующим образом:
procedure TForm1.UpdateCoordinates;
var
Temp, ShapeLeft: Integer;
begin
Temp := Shape1.Top;
StatusBar1.Panels[0].Text := IntToStr(Temp);
ShapeLeft := Shape1.Left;
StatusBar1.Panels[1].Text := IntToStr(ShapeLeft);
end;
Это уже улучшение. Конечно, дополнительный рефакторинг мог бы сделать этот код ещё лучше. Применение «Rename Local Variable» для переименования Temp во что-то вроде ShapeTop стало бы очевидным улучшением. Код можно сделать ещё более лаконичным, использовав «Inline Temporary Variable» для полного устранения переменных.
В этой статье мы узнали о правильном использовании временных переменных и о том, как применять рефакторинг «Split Temporary Variable» в Castalia для улучшения тех мест кода, где мы могли использовать их неправильно. Дополнительную информацию о других рефакторингах Castalia можно найти здесь.
Автоматическое разделение временных переменных в Delphi
By russiatips
Автоматическое разделение временных переменных в Delphi : Несколько тысяч советов, которые сделают вашу жизнь проще.