Быстрый в изучении - мощный в программировании
>> Telegram ЧАТ для Python Программистов

Свободное общение и помощь советом и решением проблем с кодом! Заходите в наш TELEGRAM ЧАТ!

>> Python Форум Помощи!

Мы создали форум где отвечаем на все вопросы связанные с языком программирования Python. Ждем вас там!

>> Python Канал в Telegram

Обучающие статьи, видео и новости из мира Python. Подпишитесь на наш TELEGRAM КАНАЛ!

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

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

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

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

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

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

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

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

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

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

Комментариев: 1
  1. А примеры?

Оставьте комментарий!

Используйте нормальные имена.

Имя и сайт используются только при регистрации

Если вы уже зарегистрированы как комментатор или хотите зарегистрироваться, укажите пароль и свой действующий email. При регистрации на указанный адрес придет письмо с кодом активации и ссылкой на ваш персональный аккаунт, где вы сможете изменить свои данные, включая адрес сайта, ник, описание, контакты и т.д., а также подписку на новые комментарии.

(обязательно)