stringtranslate.com

Pydoc

Pydoc es el módulo de documentación estándar para el lenguaje de programación Python . De manera similar a la funcionalidad de Perldoc dentro de Perl y Javadoc dentro de Java , Pydoc permite a los programadores de Python acceder a los archivos de ayuda de documentación de Python, generar páginas de texto y HTML con documentación específica y encontrar el módulo apropiado para un trabajo en particular. [1]

Se puede acceder a Pydoc desde una GUI específica del módulo , [2] desde el intérprete de Python o desde un shell de línea de comandos . [1] [3]

Desarrollado por Ka-Ping Yee, [4] [5] se incluye de forma predeterminada en todas las versiones de Python desde Python 2.1 y está disponible para descargar para 1.5.2, 1.6 y 2.0. [3]

Pydoc se utiliza para extraer documentación del propio código fuente. Se genera documentación más completa a partir de documentos externos reStructuredText utilizando el sistema de documentación Sphinx .

Ver también

Referencias

  1. ^ ab Pydoc. Consultado el 27/11/2010.
  2. ^ Usando Pydoc. Consultado el 27/11/2010.
  3. ^ ab Charming Python: módulos pydoc y distutils. Consultado el 01/01/2012.
  4. ^ "Ka-Ping Yee: Curriculum Vitae".
  5. ^ "PEP 256 - Marco del sistema de procesamiento de cadenas de documentos".

enlaces externos