Что такое __ док __ в Python?

Автор оригинала: Chris.

Python объекты имеют атрибут под названием __doc__ Это обеспечивает документацию объекта. Например, вы просто звоните Собака .__ doc__ на вашем классе Собака Чтобы получить его документацию в виде строки.

Вы можете определить DOCSTRING с помощью строки, окруженной тройными цитатами, как показано в примере:

class Dog:
    """Your best friend."""

    def do_nothing(self):
        pass


print(Dog.__doc__)
# Your best friend. 

Попробуйте сами в интерактивной оболочке Python:

Если вы уже узнали что-то из этого руководства, почему бы не присоединиться к моей бесплатной программе обучения Python? Я называю это Finxter Email Computer Science Academy -И только что: а Бесплатно, простое в использовании академия электронной почты что Обучает вас питон в небольших ежедневных дозах для начинающие и Плюсы Одинакота!

Узнайте Python и присоединяйтесь к Академии науки по электронной почте FINXTER. Это весело !

Давайте вернемся к DOCSTRING. Как все является объектом в Python (даже функциях), вы также можете определить DOCSTRING на функции:

def bark():
    """Wuff"""
    pass


print(bark.__doc__)
# Wuff

Обратите внимание, что если вы не определяете DOCSTRING, возвращаемое значение – Нет Отказ

def bark():
    pass


print(bark.__doc__)
# None

Вы хотите развивать навыки Хорошо округлый Python Professional То же оплачивается в процессе? Станьте питоном фрилансером и закажите свою книгу Оставляя крысиную гонку с Python На Amazon ( Kindle/Print )!

Зачем использовать DocStrings?

Большим преимуществом определения Docstrings в вашем коде в вашем коде в том, что вы теперь можете создать свой Собственная открытая документация программно Отказ С такими инструментами, как Сфинкс Super легко создать что-то подобное для Ваш собственный код проекты -Но, используя __doc__ значения, определенные в коде.

Лучшие практики DOCSTRING.

Есть пара лучших практик, называемых Конвенции DOCSTRING Как определено в Официальный PEP Standard Отказ Придерживаться их при определении ваших документов. Вот 7 самых важных конвенций DocString:

1. Все модули, функция, методы и классы должны иметь DocStrings.
2. Всегда используйте "" "Тройные двойные цитаты" "" вокруг ваших докладов по соображениям согласованности.
3. Используйте тройные цитаты, даже если DocString вписывается в одну строку. Это позволяет легко расширить.
4. Нет пустой строки до или после DocString – за исключением классов, где вы должны добавить одну строку после DocString.
5. Используйте фразу, которая описывает, что ваш код делает такой как "" "ДО X и верните Y." "" окончание в течение периода. Не используйте описание, такое как "" "Есть ли х и возвращает Y." "" Отказ
6. Multi-line Docstrings Начните с сводной строки (например, одноклассник DOCSTRING), за которым следует пустая строка, а затем более близкое описание, такое как Аргумент - имя человека (строка) описать один из аргументов функции или метода. Например, вы можете использовать одну строку на аргумент.
7. Начните многострочную DocString сразу в той же линии открытия «« Тройные двойные струны ... вместо начала текста в новой строке.

Если вы являетесь перфекционистом или за пределами уровня промежуточного кода, проверьте Официальная документация который содержит больше примеров.

Куда пойти отсюда?

Достаточно теории, давайте познакомимся!

Чтобы стать успешным в кодировке, вам нужно выйти туда и решать реальные проблемы для реальных людей. Вот как вы можете легко стать шестифункциональным тренером. И вот как вы польские навыки, которые вам действительно нужны на практике. В конце концов, что такое использование теории обучения, что никто никогда не нуждается?

Практические проекты – это то, как вы обостряете вашу пилу в кодировке!

Вы хотите стать мастером кода, сосредоточившись на практических кодовых проектах, которые фактически зарабатывают вам деньги и решают проблемы для людей?

Затем станьте питоном независимым разработчиком! Это лучший способ приближения к задаче улучшения ваших навыков Python – даже если вы являетесь полным новичком.

Присоединяйтесь к моему бесплатным вебинаре «Как создать свой навык высокого дохода Python» и посмотреть, как я вырос на моем кодированном бизнесе в Интернете и как вы можете, слишком от комфорта вашего собственного дома.

Присоединяйтесь к свободному вебинару сейчас!

Работая в качестве исследователя в распределенных системах, доктор Кристиан Майер нашел свою любовь к учению студентов компьютерных наук.

Чтобы помочь студентам достичь более высоких уровней успеха Python, он основал сайт программирования образования Finxter.com Отказ Он автор популярной книги программирования Python одноклассники (Nostarch 2020), Coauthor of Кофе-брейк Python Серия самооставленных книг, энтузиаста компьютерных наук, Фрилансера и владелец одного из лучших 10 крупнейших Питон блоги по всему миру.

Его страсти пишут, чтение и кодирование. Но его величайшая страсть состоит в том, чтобы служить стремлению кодер через Finxter и помогать им повысить свои навыки. Вы можете присоединиться к его бесплатной академии электронной почты здесь.

Оригинал: “https://blog.finxter.com/what-is-__-doc-__-in-python/”