Основные различия между блочными комментариями и докстрингами:
- Блочные комментарии — это многострочные пояснения к коду, которые используются для объяснения более сложного или потенциально незнакомого кода. www.8host.com Для добавления такого комментария нужно начинать каждую строку с символа решётки и одного пробела. pythonru.com
- Докстринг — это строковая переменная, которая идёт сразу за объявлением функции, класса, метода или модуля. dvmn.org Она нужна для документирования всей функции: описания входящих параметров, результата, логики, крайних случаев. dvmn.org Докстринг заключается в тройные двойные кавычки. dvmn.org
Таким образом, блочные комментарии предназначены для описания кода, а докстринги — для документации к отдельным функциям, методам, классам и модулям. all-python.ru