Домой

Последняя активность

  

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

PyDeKolt avatar PyDeKolt (0) [#] (27.05.2013 / 15:59)
Сегодня мы поговорим о том как документируется код в языке Python. Документация кода достаточно важный аспект, ведь от нее порой зависит читаемость и быстрота понимания вашего кода.

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

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

  1. # это комментарий
  2. """
  3. Это тоже комментарий
  4. но он может занимать несколько строк
  5. """

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

  1. def my(x):
  2. """
  3. Эта функция возвращает квадрат числа
  4. """
  5. return x*x
  6. class MyClass():
  7. # Этот класс делает то-то
  8. pass

Для извлечения строк документирования следует использовать атрибут __doc__
  1. print my.__doc__
  2. # вывод
  3. # Эта функция возвращает квадрат числа

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

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

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

Функция dir() позволяет получить весь список атрибутов и методов объекта.

* Как выучить Python
  Всего: 1

Зарегистрируйтесь и сможете комментировать все темы. Кнопочка вверху
Фильтр по автору
Скачать тему

В Форум

Новые вверху
waplog Рейтинг@Mail.ru
Statok.nettop-sid.ru
Яндекс.Метрика