Многострочные комментарии в Python могут быть использованы в качестве docstrings (строк документации) следующим образом: их размещают сразу после определения функции, метода, класса или модуля. 13

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

Docstrings служат для документирования кода и являются его неотъемлемой составляющей, так как к ним можно получить доступ через атрибут doc. 4

Многострочные строки документации состоят из резюмирующей однострочной строки документации, за которой следует пустая строка, а затем более подробное описание. 1

Некоторые примеры использования docstrings:

• Для модулей Python. 1 Строки документации должны содержать список всех доступных классов, функций, объектов и исключений, которые импортируются при импорте модуля. 1 Также они должны содержать краткое пояснение (в одну строку) для каждого элемента из этого списка. 1
• Для скриптов Python. 1 Строки документации должны документировать функции скрипта и синтаксис командной строки, переменные среды и файлы. 1
• Для пакетов Python. 1 Строки документации записываются в файл init.py пакета и должны содержать все доступные модули и подпакеты, экспортируемые пакетом. 1