Преимущества использования docstrings вместо комментариев в Python:
- Возможность программного доступа к docstrings. 1 Они сохраняются как атрибут функции, к ним можно получить доступ программно с помощью атрибута doc. 12
- Возможность проверки комментариев во время выполнения. 2 Это можно делать, например, в виде интерактивной справочной системы или в виде метаданных. 2
- Использование интерактивными справочными системами. 2 Например, bpython и IPython могут отображать документацию во время разработки. 2
Недостатки использования docstrings:
- Необходимость размещать docstring сразу после определения названия модуля, функции, класса или метода. 4
- Игнорирование docstrings во время выполнения кода. 4 Однако при добавлении к модулю, функции и так далее эта строка становится специальным атрибутом, доступным через doc. 4