docstring

Les chaînes délimitées (elles peuvent tenir sur plusieurs lignes) par des triples apostrophes ou des triples guillemets sont des docstrings. Elles servent à documenter les modules, les fonctions, les classes.

def ecrireSerieFibonnacci (n): # écrit la série de Fibonacci jusqu'à n, non compris .

"""Imprime les nombres de la série de Fibonacci inférieurs strictement à n."""

a, b = 0, 1

while a < n :

print a,

a, b = b, a+b

Ces chaînes sont mises dans l'attribut __doc__ de la classe, du module de la fonction. Des outils s'en servent.

Il y a aussi la fonction help qui recevant en paramètre une classe, un module, une fonction rend la chaîne de documentation.

» Glossaire du langage python