Обновлять

Всем привет! Добро пожаловать в мой еженедельный блог по поводу моего путешествия в открытом исходном котеле. На этой неделе я буду сосредоточиться на своем опыте с рефакторингом моим кодексом для ОКТО и работа с реминговой особенностью с Git. Я также хотел поделиться этим, пишешь эти сообщения в блоге, я также буду публиковать о Hackboberfest Каждую неделю до конца октября, поэтому обязательно прочитайте эти сообщения в блоге.

Код рефакторинга

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

Имена функций не достаточно ясны.

Просматривая код, я обнаружил, что некоторые имена функций не четко объясняют, что делают функции. Пример этого – GetPathinfo функция. Когда я впервые назвал функцию, которую я назвал ее на основе одной из частей функции. Теперь видишь, как эта функция действует больше похоже на Главная Функция, а не просто обрабатывать одну часть, я нашел более приспособленное имя для него. Теперь, видя эту проблему, я переименовал функцию от GetPathinfo к Главная Отказ

Избыточный код, который можно превратить в функцию

Когда я смотрел на TextTohtml и TextTohtmlwithmarkdown Функции я нашел немного избыточного кода для обработки каждой строки из файла. Я видел это и хотел написать функцию, чтобы мы могли избавиться от избыточного кода. Сначала было сложно, как преобразовать код в отдельную функцию из-за переменных, привязанных к функциональности. Как только я смог выяснить, как я хотел, чтобы функция работать с кодом, я смог заменить резервный код с помощью Linechecker функция.

// New lineChecker function
const lineChecker = (line, isFirstLine) => {

let document = ``;

if (line !== "" && isFirstLine) {

document += `
${line}
`;

} else if (line !== "" && !isFirstLine) {

document += `
${line}
`;

} else if (line === "") {

document += "
";

}

return document;

};

Избыточные переменные объявления и имена переменной нужны лучшие имена

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

Убрал неиспользуемый код

Удаление неиспользованного кода было самым легким исправлением, так как «Визуальный студийный код», которые вы хотите, не вызывается или не используется. Было также легко, потому что это очень маленький проект, и было не так много неиспользованного кода, что и крупный проект. Эта часть я только что удалил свой оригинал TextTohtml функция и заменила ее с texttohtmlfixed функция.

Перебазание и изменение истории Git

Передача моего кода было намного проще, чем я думал, что это будет. Я использовал Git Rebase -i Main и вошел в интерактивный режим, чтобы выкрутить все в один коммит. После того, как я закончил, я использовал Git Compare -Amend Чтобы редактировать мое сообщение Commit для чего-то более ясного.

Вывод

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

Оригинал: “https://dev.to/luigizaccagnini/refactoring-code-in-octo-3397”