Атрибут __doc__ Кожен об’єкт Python (функції, класи, змінні,…) надає (якщо програміст заповнив його) коротку документацію з описом його функцій. Ви можете отримати доступ до нього за допомогою таких команд, як print myobject.
Документаційні рядки в Python є рядкові літерали, які з’являються відразу після визначення функції, методу, класу або модуля. Вони використовуються для документування того, що робить об’єкт. Рядки документа, укладені в потрійні лапки, можуть бути однорядковими або багаторядковими та доступні через атрибут .__doc__ об’єкта.
Python Docstrings є рядкові літерали, які використовуються для документування вашого коду. Вони описують, що робить модуль, клас, функція чи метод, слугуючи посібником для вас та інших розробників. Ви можете використовувати рядок документації з потрійними лапками (""") і синтаксисом """[вставте сюди документацію]""" .
У Python ви можете отримати доступ до рядка документації за допомогою атрибута __doc__ об’єкта. Наприклад, ви можете отримати доступ до рядка документації для функції за допомогою моя_функція. __doc__ або рядок документації для класу, що використовує MyClass. __doc__ .
Загальнодоступні інтерфейси та правила іменування в Python
| Конвенція | приклад | Значення |
|---|---|---|
| Подвійне підкреслення на початку та в кінці | __ім'я__ | Вказує на спеціальні атрибути та методи, які надає Python |
| Одинарне підкреслення | _ | Вказує на тимчасову або одноразову змінну |