Mostrar la documentación de funciones en Python
En el cuerpo de la función se puede escribir una cadena,
describiendo la esencia del trabajo realizado. Dicha
cadena se considera convencionalmente la documentación
de la función. Se encierra entre comillas simples
y se coloca en la primera línea del cuerpo de la función.
Para leerla, es necesario utilizar una
función especial help, a cuyo parámetro
se le pasa el nombre de la función.
Supongamos que tenemos una función que suma dos números. Se ha dejado una cadena con la información correspondiente:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
Llamemos a help y averigüemos qué
está comentado en getSum:
help(getSum)
Después de ejecutar el código, aparecerá en la consola una cadena con el nombre de la función y su documentación:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
Con la función help se puede leer
la documentación de funciones estándar también. Averigüemos
información sobre la función print:
help(print)
Para mostrar solo la cadena de
documentación de la función, hay que pasar
a help después del nombre de la función la construcción
de servicio .__doc__:
help(print.__doc__)
Crea una función que reciba como parámetro una lista de nombres de meses y los muestre con la primera letra mayúscula. Describe la esencia del funcionamiento de la función en la documentación y muéstrala en la consola.
Muestra toda la documentación sobre la función sum.
Muestra solo la cadena con la documentación sobre
la función len.
