Cómo mencionamos anteriormente, una vez que nosotros definimos una función, podemos llamarla n cantidad de veces, inclusive, fuera de nuestro script, cómo lo veremos más adelante (módulos y paquetes) es por ello que una muy buena practica de programación es documentar nuestras funciones.
Para que nosotros podamos documentar una función lo haremos mediante un comentario, comentario, el cual debe de encontrarse dentro de la función y utilizando triples comillas dobles, cómo podemos observar en el siguiente ejemplo.
def mi_funcion(*args):
"""Esta es la documentación de mi_función"""
print(args)
Recordemos que al utilizar triples comillas dobles podemos colocar un comentario con saltos de línea.
Podemos trabajar con la documentación a través de su atributo ____doc____
print(mi_funcion.__doc__)
Ahora veamos un ejemplo en el cual podemos sacar provecho a nuestra documentación.
def suma(a, b):
"""Función suma"""
return a + b
def resta(a, b):
"""Función resta"""
return a - b
opciones = {'a' : suma, 'b': resta}
print("Ingrese la opción deseada")
for opcion, funcion in opciones.items():
mensaje = '{}) {}'.format(opcion, funcion.__doc__)
print(mensaje)
opcion = input("Opción : ")
Almacenamos las funciones dentro de nuestro diccionario, posteriormente iteramos los elementos del diccionario y en cada iteración imprimimos la documentación.
-
check_circle_outlineMódulo 1 | 8 clases
Introducción
expand_more -
check_circle_outlineMódulo 2 | 7 clases
Conceptos Básicos
expand_more -
check_circle_outlineMódulo 3 | 6 clases
Listas
expand_more -
check_circle_outlineMódulo 4 | 6 clases
Tuplas
expand_more -
check_circle_outlineMódulo 5 | 7 clases
Cadenas
expand_more -
check_circle_outlineMódulo 6 | 6 clases
Diccionarios
expand_more -
check_circle_outlineMódulo 7 | 9 clases
Ciclos y Condicionales
expand_more -
check_circle_outlineMódulo 8 | 14 clases
Funciones
expand_more-
done_all
Clase 1
Definir funciones
-
done_all
Clase 2
Múltiples valores de entrada y salida
-
done_all
Clase 3
Recibir N cantidad de parámetros
-
done_all
Clase 4
Args keyword
-
done_all
Clase 5
Formas de terminar una función
-
done_all
Clase 6
Alcance global
-
done_all
Clase 7
Expresiones lambdas
-
done_all
Clase 8
lambdas python
-
done_all
Clase 9
Función map
-
done_all
Clase 10
Funciones anidadas
-
done_all
Clase 11
Closures
-
done_all
Clase 12
Decoradores
-
done_all
Clase 13
Generadores
-
done_all
Clase 14
Documentación de las funciones
-
-
check_circle_outlineMódulo 9 | 12 clases
Clases
expand_more -
check_circle_outlineMódulo 10 | 8 clases
Módulos y Paquetes
expand_more -
check_circle_outlineMódulo 11 | 5 clases
Extras
expand_more -
check_circle_outlineMódulo 12.-
Examen del curso
expand_more-
done_all
Examen
Examen final del curso
-
5 comentario(s)
opciones = {'a' : suma, 'b': resta}
for opcion, funcion in opciones.items():
operacion=opciones[opcion]
def suma(a, b): """Función suma""" return a + bdef resta(a, b): """Función resta""" return a - b
opciones = {'a' : suma, 'b': resta} print("Ingrese la opción deseada")
for opcion, funcion in opciones.items(): mensaje = '{}) {}'.format(opcion, funcion.doc) print(mensaje)
opcion = input("Opción : ")