Отступы и комментарии в Python

Отступы и комментарии в Python

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

Отступы в Python

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

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

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

for i in range(1,21):
    print(i)
    if i == 7:
        break

Применение отступов в Python делает код аккуратным и чистым. В результате, программы проще читать и поддерживать.

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

if True:
    print('Hello')
    a = 5

можно написать следующим образом:

if True: print('Hello'); a = 5

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

Современные IDE и редакторы кода для Python автоматически расставляют отступы, соответственно вам не придется думать о них во время программирования. Выбрать подходящую вам IDE или редактор кода можно ознакомившись со статьей «Лучшие бесплатные IDE и редакторы кода для Python».

Комментарии в Python

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

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

Интерпретатор Python игнорирует содержимое строки комментария.

# This is a comment
# Printing hello message
print('Hello!')

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

Для того , чтобы написать комментарий на несколько строк, можно использовать символ # в начале каждой строки. Например:

# This is a long comment
# It takes
# few lines

Другой способ сделать это — использовать тройные кавычки, либо ''', либо """.

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

''' This is also
an example
of multiline comment'''

Docstring в Python

Docstring — это сокращение от «строка документации».

Это строка, которая вставляется как первая строка в определении модуля, функции, класса или метода. В нем вы должны написать, что функция/класс делает.

Например:

def double(num):
    '''Double the value'''
    return num * 2

Строка документации доступна нам как атрибут __doc__ функции:

def double(num):
    '''Double the value'''
    return num * 2

print(double.__doc__)

В результате вы увидите строку Double the value.

Источник

Просмотров:

Добавить комментарий