Что такое чистота кода?
Первым понятие "Чистота кода" было предложено в книге "Чистый код: создание, анализ и рефакторинг" (Clean Code: A Handbook of Agile Software Craftsmanship), Робертом Мартином.
В своей книге Мартин рассматривает принципы и практики написания "чистого кода", который должен быть понятным, легко читаемым, эффективным и легко поддерживаемым. Он призывает разработчиков ставить перед собой высокие стандарты в отношении своего кода, а также поддерживать его регулярным рефакторингом.
По сути чистота кода сводится к нескольким простым правилам:
- Понятные имена переменных и функций
- Единый стиль
- Комментарии в коде
- Регулярный рефакторинг
- Тестирование кода
Все пункты нацелены на то, чтобы код был читаемым и эффективным -> это упрощает его понимание, а также предотвращает возникновение глупых ошибок.
И как это работает?
Давайте более подробно рассмотрим указанные выше аспекты.
Имена переменных
- Описательные имена: Используйте имена, отражающие суть переменной. Например, вместо x предпочтительно использовать количество_студентов.
- Имена в стиле "camelCase" или "snake_case": Следуйте принятому стилю именования в выбранном языке программирования. Например, totalAmount или total_amount.
- Избегайте слишком коротких имен: Чем более конкретное и длинное имя, тем лучше. Например, num лучше заменить на количество.
Пример хорошего выбора имени:
total_students_count = 100
Пример плохого выбора имени:
x = 100
Имена функций
- Описательные имена: Как и в случаи переменных нужно использовать имена, отражающие действие, выполняемое функцией. Например, вместо doSomething() предпочтительно использовать calculateTotal().
- Единая ответственность: Каждая функция должна выполнять только одну задачу. Это делает код более понятным и облегчает тестирование.
- Избегайте побочных эффектов: Функции лучше не должны изменять глобальные переменные или состояние программы без явного указания.
Пример хорошо написанной функции:
Пример, как делать не надо:
Что происходит тут? Где комментарии? Имена переменных n и s не предоставляют ясного понимания о том, что они представляют. Появление вопросов к смыслу программы - признак плохого соблюдения правил чистоты кода. На Python кода и так немного, так может хотя бы будем писать его красиво и понятно?
Единый стиль
Соблюдение единого стиля написания кода важно по нескольким причинам:
1. Читаемость кода: Единообразие стиля делает код более читаемым и понятным. Разработчики, поддерживающие или читающие ваш код, могут быстро адаптироваться к стилю, что упрощает восприятие и понимание кода.
2. Снижение ошибок: Единообразие стиля помогает избегать ошибок, связанных с неправильным форматированием или использованием синтаксиса. Это уменьшает вероятность ошибок и упрощает поиск и их исправление.
3. Облегчение совместной разработки: Когда несколько разработчиков работают над одним проектом, единый стиль кода способствует более эффективной командной работе. Это уменьшает степень путаницы и споров относительно того, как следует форматировать код.
4. Соблюдение стандартов сообщества: Существует общепринятые стандарты написания кода для Python, такие как PEP 8 (Python Enhancement Proposal 8). Соблюдение этих стандартов помогает вашему коду быть согласованным с широким Python-сообществом и упрощает интеграцию с различными инструментами и библиотеками.
Примеры:
1. PEP 8 и отступы:
2. Использование избыточных пробелов:
3. Использование строк документации:
Продолжение следует.... ->
Наш телеграмм канал: https://t.me/ege1i5