Объяснение рефакторинга

Я не на 100% понимаю ваш вопрос, но я думаю, что вы можете сослаться на Кодовый запах, который нужно реорганизовать. Он содержит много примеров, которые вы могли бы показать другим.

Вот список того, когда следует использовать рефакторинг (список запаха кода)

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

Рефакторинг может быть искусством и требует практики. Чем больше вы это делаете, тем лучше у вас получается. Продолжайте изучать методы, описанные в книге Мартина Фаулера Ractoring, и используйте свои инструменты (Resharper для людей с Visual Studio)

Если вы еще не читали, у Мартина Фаулера есть отличная книга по этой теме под названием Рефакторинг: улучшение дизайна существующего кода. Он подробно описывает, как и почему нужно реорганизовать конкретный фрагмент кода.

Я не решился даже упомянуть об этом из опасения, что знание этой книги предполагается кем-то, кто спрашивает о рефакторинге, и что вы подумаете: «Ага, я имел в виду Помимо, книгу Фаулера». Но что за эй, вот и все. :-)

Вы не упоминаете тесты. Чтобы «доказать», что рефакторинг не нарушает существующую функциональность, вам необходимо либо иметь существующие тесты, либо написать тесты перед выполнением рефакторинга.

Как и в большинстве случаев программирования, навык рефакторинга требует практики и опыта. Было бы неплохо думать, что этому можно научить, но этому нужно научиться - и есть значительная разница в объеме обучения, которое можно выполнить в разных средах.

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

Один простой способ представить себе рефакторинг прямо в названии - это как если бы вы вычленили общую переменную из уравнения:

xy + xz

становится

x(y + z)

X был исключен. Рефакторинг кода - это то же самое, потому что вы находите повторяющийся код или логику и вычленяете их из него.

Похоже, ваш подход очень хорош. В конце процесса вы показали, как вы можете обнаружить и исправить множество проблем. В образовательных целях было бы интересно изобрести новое изменение / улучшение / исправление. Затем вы можете спросить своего наставника, как они будут вводить это изменение со старой и новой кодовой базой. Надеюсь, они увидят, что внести новое изменение с помощью отремонтированного кода намного проще (или как дополнительный рефакторинг будет самым простым способом подготовиться к гипотетическому изменению).

Я вижу несколько разных способов научить рефакторингу:

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

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

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

Научить кого-то рефакторингу, когда он не является естественным, - трудная работа. По моему опыту, лучше всего сесть с ними в офисе и провести рефакторинг кода. Пока вы это делаете, поддерживайте диалог «поток сознания». Обсудите, что вы видите, почему код не пахнет, варианты рефакторинга и т. д. Также вы должны убедиться, что они делают то же самое. Самое важное - объяснить, почему, а не как изменить код. Любой порядочный программист может внести изменения и заставить их работать, но требуются навыки и опыт, чтобы суметь заявить, почему новое решение лучше, чем предыдущее.