Инструменты пользователя

Инструменты сайта


pydoc

Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

pydoc [2018/08/28 03:51] (текущий)
Строка 1: Строка 1:
 +====== Pydoc модуль документации для Python ======
 +  * [[http://​docs.python.org/​library/​pydoc|pydoc — Documentation generator and online help system]]
 +
 +{{htmlmetatags>​
 +metatag-description=(Pydoc - стандартный модуль документации для языка программирования Python.)
 +}}
 +
 +Python предлагает механизм документирования кода pydoc. В начало каждого модуля,​ класса,​ функции вставляется строка документации,​ что используется современными IDE (например,​ [[Eclipse]]).
 +
 +Документацию по pydoc, можно вывести командой:​
 +<code bash>
 +$ pydoc pydoc
 +Help on module pydoc:
 +
 +NAME
 +    pydoc - Generate Python documentation in HTML or text for interactive use.
 +
 +FILE
 +    /​usr/​lib/​python2.6/​pydoc.py
 +
 +MODULE DOCS
 +    /​usr/​share/​doc/​python2.6/​html/​library/​pydoc.html
 +...
 +</​code>​
 +Для просмотра документации по модулям [[Python]] pydoc можно запустить в виде WEB - сервера:​
 +<​code>​
 +$ pydoc -p 8081
 +pydoc server ready at http://​localhost:​8081/​
 +</​code>​
 +Чтобы сгенерировать HTML-документацию для модуля,​ в виде module_name.html,​ необходимо выполнить:​
 +<​code>​
 +$ pydoc -w module_name
 +</​code>​
 +
  
загрузка...
pydoc.txt · Последние изменения: 2018/08/28 03:51 (внешнее изменение)