Bonjour, j'ai besoin d'aide pour ces 3 programmes svp il faut créer une documentation, je n'y arrive pas :

# Exemple 1:
def lettrePlusFrequente(mot):
'''
donner une documentation à cette fonction (rôle, paramètre et type, retour)
'''
# Pré-condition: ...
maxi = 0
for c in mot:
n = compte(c, mot)
if n > maxi:
lettre = c
maxi = n
return (lettre, maxi)

# Exemple 2:
def moyenne(liste_nombres):
'''
donner une documentation à cette fonction (rôle, paramètre et type, retour)
'''
# Pré-condition: ...
somme = 0
longueur = len(liste_nombres)
for nombre in liste_nombres:
somme = somme + nombre
moyenne = somme/longueur
return moyenne

# Exemple 3:
def total(d):
'''
donner une documentation à cette fonction (rôle, paramètre et type, retour)
'''
# Pré-condition: ...
compteur = 0
for i in d.values():
compteur = compteur + i
return compteur


Sagot :

Réponse :

Tu écris ce que fait la fonction dans chaque '''...''' par fonction

Par exemple :

def patate(chiffre):

'''

la fonction permet de retourné le mot "patate" un nombre "chiffre" de fois

chiffre : le nombre de fois où je dois écrire "patate"

'''

Tu as 2 types de commentaires

#Ce commentaire ne peut contenir que une ligne

'''Ce commentaire peut faire plusieurs lignes et est utilisé pour renseigner sur ce que fait une fonction'''

Réponses :

Exemple 1

"""

Cette fonction retourne la lettre et le nombre de fois qu'elle apparait dans le mot "mot" qu'elle prend en paramètre. Son type de retour est une chaine de caractère str.

"""

Exemple 2

"""

Cette fontion retourne la moyenne des nombres d'une liste de nombre (liste_nombre) qu'elle prend en paramètre. Son type de retour est un nombre entier int.

"""

Exemple 3

"""

Cette fonction retourne le nombre d'élément que contient un dictionnaire (d) passé en paramètre. Son type de retour est un nombre entier int.

"""

Comme l'a répondu plus haut un autre utilisateur, il faut décrire la fonction entre les """ ... """ .