Инструкции, отступы и комментарии в Python

В этом руководстве вы узнаете об операторах в Python, о важности использования отступов и комментариев.

Инструкции

Инструкции, которые может выполнять интерпретатор Python, называются операторами. Например, a = 1 — это оператор присваивания. Оператор if, оператор for, оператор while и т. д. — это другие типы операторов, которые мы обсудим позже.

Многострочные инструкции

В Python для окончания инструкции используют символ новой строки. Но можно разбить инструкцию на несколько строк символом продолжения строки (\). Например:

a = 1 + 2 + 3 + \
    4 + 5 + 6 + \
    7 + 8 + 9

Это явное продолжение строки. В Python продолжение строки выполняется внутри круглых ( ), квадратных [ ] и фигурных скобок { }. Например, так мы можем реализовать показанную выше многострочность:

a = (1 + 2 + 3 +
    4 + 5 + 6 +
    7 + 8 + 9)

Здесь круглые скобки ( ) неявно продолжают строку. То же самое с [ ] и { }. Например:

colors = ['красный',
          'голубой',
          'зеленый']

Мы также можем поместить несколько выражений в одну строку с помощью точки с запятой, как показано ниже:

a = 1; b = 2; c = 3

Отступы

Большинство языков программирования, таких как C, C ++ и Java, используют фигурные скобки { } для определения блока кода. Однако Python использует отступы.

Блок кода (тело функции, цикла и т. д.) начинается с отступа и заканчивается первой строкой без отступа. Размер отступа зависит от вас, но он должен быть одинаковым на протяжении всего блока.

Как правило, для отступов используют четыре пробела или табуляцию. Вот пример:

for i in range(1,11):
    print(i)
    if i == 5:
        break

Применение отступов в Python делает код аккуратным и чистым. Программы благодаря отступам выглядят последовательными. С ними блоки кода визуально легче отличать друг от друга. 

Сравните:
if True:
    print('Привет')
    a = 5

и

if True: print('Привет'); a = 5

Оба варианта допустимы и сделают одно и то же, но первый вариант — читабельнее.

Неправильный отступ приведет к ошибке IndentationError.

Комментарии

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

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

В Python для комментариев используется символ решетки (#).

Комментарий заканчивается символом новой строки. Интерпретатор Python игнорирует комментарии.

#Это комментарий
#выводим «Привет»
print('Привет')

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

В Python можно использовать многострочные комментарии. Один из способов — использовать символ решетки (#) в начале каждой строки. Например:

#Это длинный комментарий,
#и он продолжается
#на несколько строк

Можно поступить иначе — использовать тройные кавычки: ''' или """.

Тройные кавычки обычно используются для многострочных строк. Но их также можно использовать для многострочных комментариев. Если они не являются строками документации, они не создают никакого дополнительного кода.

"""Это тоже
пример прекрасного
многострочного комментария"""

Строки документации (docstrings) в Python

Docstring — это сокращение от documentation string (строка документации).

Строки документации в Python — это строковые литералы, которые появляются сразу после определения функции, метода, класса или модуля.

При написании строк документации используются тройные кавычки. Например:

def double(num):
    """Функция, которая удваивает значение"""
    return 2*num

Строки документации появляются сразу после определения функции, класса или модуля. Это и отличает их от многострочных комментариев, написанных с использованием тройных кавычек.

Строка документации связана с объектом как его атрибут __doc__.

Так что мы можем получить доступ к строкам документации функции с помощью следующих строк кода:

def double(num):
    """Функция, которая удваивает значение"""
    return 2*num
print(double.__doc__)

Вывод:

Функция, которая удваивает значение
codechick

СodeСhick.io - простой и эффективный способ изучения программирования.

2024 ©