Documentar funciones
Documentar una función desarrollada en el interprete de Python es muy sencillo, en una publicación anteriores se vio como restringir la falta de argumentos de una función, en el bloque siguiente se muestra un ejemplo de una función que se requiere documentar.
def sumar(a,b):
c = a + b
return c
La función anterior únicamente suma dos argumentos y muestra los resultados, para documentarla se procede la forma siguiente:
def sumar(a,b):
'''F.Sumar: Suma de dos números.
c = a + b
La función requiere ambos valores númericos '''
c = a + b
return c
Consultar la documentación de una función
Si utilizas el IDLE podrás notar un mensaje emergente como el que se muestra a continuación.
En caso de usar la consola necesitarás teclear la instrucción del bloque siguiente:
sumar.__doc__
