Справочник · модуль 5 «Функции»

Описание функции

Первая строчка внутри функции в тройных кавычках — описание. Оно объясняет, что делает функция.

Сравнение из жизни

Как надпись на коробке с инструментом.

Пример

def area(width, height):
    """Возвращает площадь прямоугольника."""
    return width * height

print(area(3, 4))
Результат
12

Учитель в уроке Первая строчка в тройных кавычках — это описание. Python её не читает. Оно нужно людям. Редактор показывает его, когда наводишь курсор на имя.

Запомнить

Описание функции — как надпись на коробке с игрушкой. Сразу понятно, что внутри и как этим пользоваться.

Частые ошибки новичков на этой теме

Тема из урока 5.5 «Понятные функции» курса PythonAZ.

В этом же уроке