Tomado de Documentación. Vídeo 75

La documentación es incluír comentarios en el código que se escribe. Es una buena práctica de programación proporcionar información clara y detallada sobre el diseño, funcionamiento y utilidad de cada clase, método, módulo o bloque de código. Sirve para ayudar al trabajo en equipo, especialmente en aplicaciones complejas, y para tener una idea clara de lo que el código realiza o sobre el funcionamiento del programa en caso de una futura revisión.

Los comentarios para documentar código se escriben entre triple comillas dentro de la definición de una clase, método o módulo. Ver comentar con # versus """

• print(ruta/elemento.doc): Imprime la documentación de la clase, método o módulo.

• help(ruta/elemento): Ofrece una información más detallada de la documentación de la clase, método o módulo.

Dentro de la triple comilla de la documentación de una clase, método o módulo, luego de los comentarios, se escribe:

>>> nombre_funcion(arg1, arg2,...,argn)
... # Si hay líneas que necesiten sangría se ponen 3 puntos.
# Lo que la función debería retornar. Tener en cuenta el tipo de valor:

Importar el módulo doctest y utilizar su método testmod() para ejecutar las pruebas. Dicho método retorna un mensaje de error si la prueba falló y no retorna nada si la prueba es exitosa.