Курс Python → Правила именования переменных

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

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

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

Пример кода:


def calculate_area_of_rectangle(length, width):
    """
    Функция для вычисления площади прямоугольника
    :param length: длина прямоугольника
    :param width: ширина прямоугольника
    :return: площадь прямоугольника
    """
    area = length * width
    return area

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

Твои коллеги будут рады, поделись в

Автор урока

Дмитрий Комаровский
Дмитрий Комаровский

Автоматизация процессов
в КраснодарБанки.ру

Другие уроки курса "Python"

  1. Оператор walrus в Python
  2. Преобразование чисел в Python
  3. Повторение и перенос строки
  4. Docstring в Python
  5. Преобразование данных в Python
  6. Извлечение данных из JSON
  7. Группы исключений в Python
  8. Метод сравнения объектов в Python
  9. Извлечение чисел из текста
  10. PrettyTable: создание таблицы
  11. Обработка исключений в Python
  12. Возвращение нескольких значений через кортеж или класс
  13. Поиск уникальных и повторяющихся элементов
  14. Декоратор Property в Python
  15. Создание генераторов
  16. Обновление и получение данных в SQLite
  17. Обязательные аргументы в Python
  18. Создание графики с черепахой
  19. Использование функции product
  20. Antigravity модуль
  21. Решение переменной Шредингера
  22. Обратный список чисел
  23. Избегайте ошибку FileNotFoundError
  24. Сериализация и десериализация объектов
  25. Генерация QR-кодов с библиотекой qrcode
  26. Настройка шрифта и цвета в Tkinter
  27. Сравнение def и lambda-функций
  28. Запуск внешнего кода в Jupyter
  29. Разделение списка на гнппы
  30. lru_cache оптимизация функций
  31. Переменные в Python
  32. Список переменных в Python
  33. Работа с набором данных CIFAR10 в PyTorch
  34. Работа с NumPy массивами
  35. Установка и использование модуля Wikipedia
  36. Выражения-генераторы в Python
  37. Игра «Угадывание чисел»
  38. Форматирование кода на Python
  39. Установка и использование Logzero
  40. Использование подчеркивания в REPL
  41. Преобразование Excel в PDF с Spire.XLS
  42. Оформление кода по PEP 8
  43. Метод radd для пользовательских чисел
  44. Избегайте пустого списка
  45. Нахождение самого длинного слова в списке с помощью max
  46. Сортировка с помощью параметра key
  47. Экспорт внешнего файла с помощью writefile
  48. Переопределение унарных операторов

Marketello читают маркетологи из крутых компаний