Продолжаю изучать Python и одновременной рассказывать об этом. Хотя, конечно, вру ))) Не одновременно. Изучаю постоянно, а рассказываю по мере наличия свободного времени. И сегодня о многострочных комментариях, или, как это называют в некоторых источниках - о строках документации.
О комментариях в Python я очень подробно рассказал здесь. Однако там я не решился показать многострочные комментарии, поскольку в документации о них ничего не нашёл. Но позже я встречал их в литературе и других источниках, поэтому решил, что можно )))
Строка документации (docstring) - это строка в начале функции, которая объясняет назначение и интерфейс функции. Или в начале модуля, программы и т.п.
Однако такое описание редко удаётся поместить в одну строку. Обычно оно занимает несколько строк. В этом случае использовать обычные символы (#) комментариев Python не очень удобно. Поэтому разработчики Python предусмотрели ещё один способ - тройные кавычки:
Всё, что находится между парой тройных кавычек, является в Python многострочным комментарием (ну или строками документации - называйте как нравится).
Также обратите внимание, что редактор исходного кода отличает строки документации от обычных комментариев, и выделяет их разным цветом. Правда, именно этот редактор я написал для себя сам, в вашем случае это может быть по-другому. Стандартная IDLE, например, ведёт себя немного странно, хотя и не ругается - она при нажатии ENTER после ввода многострочного комментария выводит его же на экран:
При этом подсветка строк документации имеет цвет обычных строк.
На этом всё. Подписывайтесь на канал или подключайтесь к Телеграм-каналу, чтобы ничего не пропустить.