Documentation et commentaires

by Christian Nguyen, Joseph Razik, last modified on 2016-03-19
documentation_commentaires

'__doc__' et help() pour une fonction

In [1]:
def doc_fonction(x=0):
    """
    Cette fonction très compliquée retourne la valeur du paramètre
    augmentée de la valeur 1.
    Si aucun paramètre n'est spécifié alors la valeur par défaut est 0.
    @param x: la valeur à traiter
    @return: x + 1
    """
    return x + 1  # 1 a été choisi car plus petit que 2 et plus grand que 0
In [2]:
# le print de __doc__
print('documentation de la fonction\n', doc_fonction.__doc__)

documentation de la fonction
 
    Cette fonction très compliquée retourne la valeur du paramètre
    augmentée de la valeur 1.
    Si aucun paramètre n'est spécifié alors la valeur par défaut est 0.
    @param x: la valeur à traiter
    @return: x + 1
In [3]:
# le help
help(doc_fonction)

Help on function doc_fonction in module __main__:

doc_fonction(x=0)
    Cette fonction très compliquée retourne la valeur du paramètre
    augmentée de la valeur 1.
    Si aucun paramètre n'est spécifié alors la valeur par défaut est 0.
    @param x: la valeur à traiter
    @return: x + 1
In [4]:
# que les commentaires n'apparaissent pas

'__doc__' et help() pour un module

In [5]:
# marche aussi pour les modules
import modulex as m
print('documentation du module\n', m.__doc__)

importation => execution ?
documentation du module
  Petit module de test pour l'importation.
In [6]:
help(m)

Help on module modulex:

NAME
    modulex - Petit module de test pour l'importation.

FUNCTIONS
    g()
        ###############################################################
        # fonction "publique"
    
    get_x()
        L'accesseur.
    
    set_x(pentier)
        Le mutateur

DATA
    y = 1

FILE
    /home/razik/Cours/I22/cours_python/modulex.py