25/3/2020 Documentación de las funciones

  Buscar... PREMIUM

En apoyo a tu economía, 3 meses de Premium por 8USD VER PROMO

NO ME INTERESA

Documentación de las funciones

Abrir temario 

Lo lees en 1 Min.

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.

https://codigofacilito.com/articulos/documentacion_funciones 1/5
25/3/2020 Documentación de las funciones

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.

https://codigofacilito.com/articulos/documentacion_funciones 2/5
25/3/2020 Documentación de las funciones

ANTERIOR TEMA SIGUIENTE TEMA

Dudas y Comentarios Acerca del curso

AGREGAR COMENTARIO O DUDA

Necesitas confirmar tu correo electrónico para comentar

Enviar mail de confirmación

Usar markdown
 PUBLICAR

baldeaguirre publicó en Documentación De Las Funciones

06 Febrero 18
2
En la función: 
def resta (a, b):
Es: 
return a + b
O:
return a - b?

https://codigofacilito.com/articulos/documentacion_funciones 3/5
25/3/2020 Documentación de las funciones

Ver comentarios (3) 

Escribe aquí

 PUBLICAR

Luigi95 publicó en Documentación De Las Funciones

15 Octubre 19

en si que es lo que se tendria que mostrar en pantalla? No lo entendi del todo el

ejemplo 

Ver comentarios (4) 

Escribe aquí

 PUBLICAR

CONTENIDO CURSOS

Cursos Web
Talleres Móvil
Premium Frontend
Artículos Backend

CUENTA REDES SOCIALES

Cerrar sesión
Soporte y Ayuda

https://codigofacilito.com/articulos/documentacion_funciones 4/5
25/3/2020 Documentación de las funciones

https://codigofacilito.com/articulos/documentacion_funciones 5/5