Волшебные слова, которые превратят «плохой» код в «хороший»
Всем привет! Вы уже получили приглашение в Хогвартс? Нет? У меня есть нечто потрясающее! Инсайт из одного из уроков под названием «Как сохранить свой код» или что-то в этом роде.
Я поделюсь идеями, как превратить ваш проект из ужасного в сказочный. Превратите плохую кодовую базу, полную огромного количества ошибок и слабой архитектуры, в эффективную и последовательную.
PS Все мы знаем, что можно написать с нуля, но это не всегда так и слишком очевидно, чтобы осветить в моей статье.
Заботимся ли мы о коде?
Представьте себе проект, который кто-то инициировал много лет назад. Наверняка было много «горячих исправлений», TODO и технических долгов. И еще один — приоритетный проект с огромным бюджетом. Приложение приносит доход бизнесу и имеет множество полезных функций.
Какой проект вам будет интересен больше?
Если ваш ответ — второй, пора изменить приоритеты.
Помните первую строку этой статьи? "Разработчики"! Мы хотим быть разработчиками, а не программистами, поэтому нам следует заботиться о всем коде, который мы поддерживаем. Давайте бороться за лучшее качество кода и сделаем это на 100%! Это действительно истинный путь любого разработчика.
Теперь давайте посмотрим на мой контрольный список проектов с плохим кодом. Вот как можно продлить его жизнь на долгие годы!
1. Линтеры
Убедитесь, что у вас правильно установлены все линтеры и конфигурации.
- Эслинт(js)
- Красивее (js)
- Stylelint (например, scss, css, sass)
Это самое меньшее, что могло бы помочь вам на протяжении всего пути. Не ленитесь и потратьте много времени на создание подходящих конфигов. Они ваши самые близкие друзья, а не враги!
2. Поймите суть
Прежде чем приступить к следующим огромным изменениям, вы должны быть на 1000% осведомлены об основных функциях. Поймите, как работают основные функции, и напишите некоторое количество тестов, охватывающих варианты использования. Это поможет понять, все ли вы сломали и в лучшем случае, где искать исправление.
Помните: никогда не начинайте переписывать текст, даже не пройдя базовое тестирование!
3. Начать проверку и внедрить DRY, KISS, SOLID.
Я рекомендую начать читать «Чистый код» Роберта К. Мартина во время или даже раньше. Или перечитайте еще раз, я уверен, что это может дать вам много свежих идей о том, как улучшить ваш код. Но не пытайтесь сделать все сразу!
4. Маленькие коммиты
Разделите изменения на небольшие логические фиксации, чтобы избежать беспорядка, когда вам придется отменить некоторые нежелательные изменения.
5. Один шаг для очистки кода каждого коммита
У вас должно быть правило вносить даже небольшие изменения, которые улучшают читабельность. Переименовывайте странные имена или разбивайте сложные функции на более мелкие. Что бы ни! Делайте это для каждого коммита без исключения.
Ваша цель — читать код как можно быстрее, проще и понятнее, так что работайте над этим!
6. Оцените каждую новую ошибку, которую вы исправили, с помощью теста.
Делайте это сразу после исправления, оно в этой же ветке. Никогда не откладывайте это! Всегда старайтесь делать все, что можете. Итак, что вы можете сделать сейчас? Надеюсь, вы воспользуетесь моим списком как контрольным, а затем поделитесь своим мнением в комментариях. И подписывайтесь конечно, поскорее :)
Надеюсь, эта статья была для вас полезна!
Желаю вам всегда любить свой код!
Увидимся! :)
