В прошлой статье мы немного поговорили о том, как важно поддерживать чистоту своего кода, а именно заострили внимание на следующих аспектах:
- Понятные имена переменных и функций - ✅ ->
- Единый стиль - ✅
- Комментарии в коде - ❓
- Регулярный рефакторинг - ❓
- Тестирование кода - ❓
(Галочкой отмечены темы, которые мы уже разобрали в предыдущей статье)
Теперь давайте поговорим о том, какие еще аспекты следует рассмотреть для поддержания чистоты кода:
Комментирование
Комментарии в коде играют важную роль в объяснении его структуры, логики и особенностей. Они помогают другим разработчикам (включая вас в будущем) лучше понять, что происходит в коде, особенно если он сложный или содержит нетривиальные решения.
Но важно использовать комментарии разумно и избегать излишнего их количества, так как избыточные комментарии могут затруднить чтение кода, однако и их недостаток не сделает ваш код понятнее) Вот несколько примеров использования комментариев в Python:
Объяснение логики
В этом примере комментарий объясняет цель функции и ее ожидаемое поведение.
Объяснение сложных участков кода
Этот комментарий помогает понять, что делает цикл и почему в нем используется счетчик i.
Документирование функций
Этот комментарий описывает назначение функции, ее параметры и возвращаемое значение. Такие комментарии называются docstrings и используются для автоматической генерации документации.
TODO-заметки
Этот комментарий указывает на то, что функция нуждается в доработке или реализации.
Объяснение временных решений или ограничений
P.S. Костыли использовать вредно 😅
Рефакторинг
Рефакторинг кода - это процесс изменения внутренней структуры программы без изменения ее внешнего поведения. Цель рефакторинга состоит в улучшении кода, делая его более понятным, читаемым, поддерживаемым и эффективным, при этом не изменяя функциональности программы.
Если не сильно заморачиваться -> переписывание старого кода, учитывая новые вводные.
Вот несколько примеров, которые показывают важность рефакторинга на Python:
Улучшение читаемости кода
Исходный код
После рефакторинга
В этом примере функции calc_area и calc_perimeter были объединены в одну функцию calculate_rectangle_properties, что делает код более читаемым и легко поддерживаемым.
Устранение дублирования кода
Исходный код
После рефакторинга
Здесь функции apply_discount и apply_voucher были объединены в одну функцию с параметром discount_rate, чтобы устранить дублирование кода.
Улучшение структуры именования
Исходный код
После рефакторинга
Итог: рефакторинг важен и нужен -> делаем) Ну, а если серьезно: рефакторинг кода важен, потому что помогает сохранить и улучшить качество программного обеспечения. Он позволяет сделать код более читаемым, поддерживаемым и эффективным, что упрощает его дальнейшее развитие и обеспечивает долгосрочную устойчивость проекта.
Тестирование
Ну вот мы и добрались до самого интересного..
Тестирование - это процесс проверки программного обеспечения с целью выявления ошибок, дефектов или несоответствий заданным требованиям. Оно играет важную роль в разработке программ, так как помогает обнаружить и исправить проблемы до их появления в продукте, что повышает его качество и надежность.
Вообще вопрос тестирование - это повод для отдельной статьи, поэтому здесь мы затронем его только слегка.
Зачем надо тестировать программу?
Вообще вопрос слегка неуместный -> нам надо понять работает ли наша программа в принципе, выводит она именно то, что мы от нее ожидаем, а также как быстро она это делает. Я перечислил только несколько из вопросов, которые нам надо выяснить при тестировании.
Резюмируя для каких задач нам нужно тестирование:
- Выявление ошибок
- Подтверждение правильности работы
- Повышение надежности
- Улучшение качества
Таким образом, тестирование программы является неотъемлемой частью процесса разработки и играет ключевую роль в обеспечении качества и надежности программного обеспечения.
Итоги
Я мог бы снова написать о том, как это все важно и насколько упрощает процесс разработки, но хочу просто предоставить своим читателем ознакомится с данной цитатой:
Пишите код так, как будто сопровождать его будет склонный к насилию психопат, который знает, где вы живёте. - Джон Ф. Вудс
Наш телеграмм канал: https://t.me/ege1i5