Константы и коментарии в Python

При написании кода вам может потребоваться сохранить значения в переменных при этом вы не хотите изменять эти значения на протяжении выполнения программы.

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

Плохая новость заключается в том, что Python не поддерживает константы.

Чтобы обойти это, просто пишите все буквы заглавными в имени переменной, чтобы указать, что переменную следует рассматривать как константу. Например:

MAX_FILE_LIMIT = 300

Сталкиваясь с подобными переменными, вы не должны изменять их значения. Эти переменные постоянны по соглашению, а не по правилам.

Введение в комментарии Python

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

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

При выполнении программы интерпретатор Python игнорирует комментарии и интерпретирует (считывает) только код.

Python предоставляет три вида комментариев:

-блочный комментарий,

-встроенный комментарий

-строку документации

Блочные комментарии

Блочный комментарий объясняет следующий за ним код. Обычно отступ в комментарии к блоку делается на том же уровне, что и в блоке кода.

Чтобы создать блочный комментарий, вы начинаете с одного знака решётки (#), за которым следует один пробел и текстовая строка. Например:

# Увеличение цены на 5%
price = price * 1.05

Встроенные комментарии Python

Когда вы помещаете комментарий в ту же строку, что и оператор, вы получите встроенный комментарий.

Подобно блочному комментарию, встроенный комментарий начинается с одного знака решётки (#), сопровождается пробелом и текстовой строкой.

Следующий пример иллюстрирует встроенный комментарий:

salary = salary * 1.02 # Увеличение ЗП на 2%

Строки документации Python

Строка документации - это строковый литерал, который вы помещаете в качестве первых строк в блоке кода, например, в функции.

В отличие от обычного комментария, к строке документации можно получить доступ во время выполнения, используя атрибут obj.__doc__ , где obj это имя функции.

Обычно строки документации используются для автоматического создания документации по коду.

Строки документации называются docstrings .

Технически говоря, строки документации - это не комментарии. Они создают анонимные переменные, которые ссылаются на строки. Кроме того, они не игнорируются интерпретатором Python.

Python предоставляет два вида строк документации: однострочные и многострочные.

1) Однострочные

Как следует из названия, однострочная документация помещается в одну строку. Однострочная документация начинается с тройных кавычек (""") и также заканчивается тройными кавычками ("""). Кроме того, не будет ни одной пустой строки ни до, ни после однострочной строки документации.

Следующий пример иллюстрирует однострочную строку документации в sort() функции:

def sort():
""" отсортируйте список с помощью алгоритма """

2) Многострочные строки документации

В отличие от однострочной строки документации, многострочная строка документации может занимать несколько строк. Многострочная строка документации также начинается с тройных кавычек (""") и заканчивается тройными кавычками (""").

В следующем примере показано, как использовать многострочные строки документации:

def increase(salary, percentage, rating):

""" увеличить заработную плату в зависимости от рейтинга

рейтинг 1 - 2 без повышения
рейтинг 3 - 4 увеличение на 5%
рейтинг 5 - 6 увеличение на 10%
"""

Многострочные комментарии на Python

Python не поддерживает многострочные комментарии.

Однако вы можете использовать многострочные строки документации в качестве многострочных комментариев. Гвидо ван Россум, создатель Python, также рекомендовал это решение.

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

Краткие сведения

• В Python нет встроенных типов констант.
• По соглашению, Python использует переменную, имя которой содержит все заглавные буквы, для определения константы.
• При необходимости используйте комментарии для документирования вашего кода.
• Блочный комментарий и встроенный комментарий начинаются со знака решётки (#).
• Используйте строки документации для функций, модулей и классов.

#IT #Python #Саморазвитие #Обучение