Основы синтаксиса

Комментарии в Python — это пояснительный текст, который игнорируется интерпретатором и служит для документирования кода и объяснения его логики разработчикам; они добавляются с помощью символа # для однострочных комментариев или тройных кавычек '''...''' или """...""" для многострочных

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

Пример использования docstring В примере ниже docstring используется для класса и метода:

class Dog: """ Это класс собаки. """

def bark(self):
    """
    Собака лает из метода!
    """
    return True

animal = Dog() print(animal.doc) print(animal.bark.doc) Результат будет выглядеть следующим образом:

Это класс для представления собаки.
Метод, который заставляет собаку лаять.

Часто бывают ситуации, когда нужно закомментировать фрагмент кода (1 строку или сразу несколько строк подряд). Для этого просто выберите нужный фрагмент кода и нажмите Ctrl + / (Cmd + / для Mac OS)

... Ellipsis

pass