Python dispose d'un système de documentation intégré appelé pydoc. C'est à ce mécanisme que vous avez accès lorsque vous utilisez la fonction help() en mode interactif, ou que vous utilisez la commande pydoc du shell. La documentation se fait très simplement à l'aide de chaînes de caractères entre guillemets appelées docstrings. La PEP 0257 définit le bon usage de ces chaînes :
01: def ma_fonction(a, b):
02: """
03: Description de ce que fait ma_fonction
04:
05: Paramètres:
06: a -- Description du paramètre a
07: b -- Description du paramètre b
08: """
09: ...
En tapant ensuite help(ma_fonction) dans un interpréteur interactif, on obtiendra :
Help on function ma_fonction in module __main__:
ma_fonction(a, b)
Description de ce que fait ma_fonction
Paramètres:
a -- Description du paramètre a
b -- Description du paramètre b
(END)
Cette technique permet donc de documenter très simplement et très rapidement le code. Par contre, il n'y a aucune...
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première