Документирование кода в Python

Сегодня мы поговорим о том как документируется код в языке Python. Документация кода достаточно важный аспект, ведь от нее порой зависит читаемость и быстрота понимания вашего кода.

Как это делается?

Строки комментария можно оставлять используя символ # или открывающие """ и закрывающие """

Документировать файлы модулей, функции и классы необходимо следующим образом. В модулях комментарий располагается в начале файла, в функциях и классах после объявления.

Для извлечения строк документирования следует использовать атрибут __doc__

Или же воспользоваться функцией help(<объект>)

Получаем информацию об объектах.

Сделать очень легко, нужно поместить объект в функцию dir(<объект>)

Функция dir() позволяет получить весь список атрибутов и методов объекта. Ищите хорошие программы для Android? Советуем Вам качественные программы для Android. Качественнее не найдете.