8.1   Documentación

Documentar nuestros programas, módulos y ejemplos en Python no representa un esfuerzo adicional si hemos incluído las cadenas de documentación. Para el caso de un módulo, podemos incluir las siguientes cadenas:

'''Cadena de descripción del módulo 
 
Puede tener una línea de encabezado, 
y después uno o más párrafos de explicación...''' 
 
__author__ = 'xxxx xxxx' 
__date__ = 'xxxx xxxx' 
__version__ = 'xxxx xxxx' 
__credits__ = 'xxxx xxxx' 
__text__ = 'xxxx xxxx' 
__file__ = 'xxxx xxxx'

Las funciones para generar HTML las incluímos todas en un archivo html.py, al cual agregamos al inicio las cadenas anteriores. Después con la herramienta pydoc incluída con Python, podemos generar un archivo html.*html* con la documentación del mismo:

[usuario@pc ejemplos]$ /usr/lib/python2.1/pydoc.py -w ./html.py

Escribimos './' antes del nombre del archivo, para que pydoc sepa que es un archivo y no un módulo predefinido.

prueba-de-m-dulos [1]8.2   Prueba de módulosprueba-de-m-dulos