Урок 13. Строки документации в Python - docstrings. Атрибут __doc__ и функция help()
В коде строки документации (docstrings) предназначены для разъяснения назначения модулей, классов и функций, а также описания их интерфейсов. Этим докстринги отличаются от комментариев, основное назначение которых пояснять особенности работы кода, программную логику, алгоритм.
В Python строка документации вставляется первым выражением в тело объекта (модуля, класса или функции/метода) и заключается в тройные кавычки. При обработке транслятором строка будет помещена в атрибут _doc_ объекта. Программист, использующий данный объект, может получить docstring, обратившись к этому атрибуту.
Встроенная функция help() языка программирования Python запускает утилиту интерактивной справочной системы, которая может считывать docstrings и выводить их в структурированном виде. При передачи аргумента в функцию help выводятся строки документации по данному аргументу, например, модулю.
Текстовая версия урока: https://younglinux.info/oopython/doc
Курс на сайте: https://younglinux.info/oopython/course
Курс с решениями и пояснениями к практическим работам:
в приложении для андроид: https://play.google.com/store/apps/de...
PDF-версия: https://younglinux.info/store/store.h...
Смотрите видео Урок 13. Строки документации в Python - docstrings. Атрибут __doc__ и функция help() онлайн без регистрации, длительностью часов минут секунд в хорошем качестве. Это видео добавил пользователь Лаборатория линуксоида 05 Октябрь 2021, не забудьте поделиться им ссылкой с друзьями и знакомыми, на нашем сайте его посмотрели 1,73 раз и оно понравилось 3 людям.