Magazine
Spécialité(s)
Résumé
Documenter un code est une perte de temps en première intention. On a le sentiment de ne pas être productif, que le projet sur lequel on travaille n'avance pas. Pourtant, pour peu que l'on développe en équipe ou que le projet soit mis en attente ne serait-ce qu'une semaine, la documentation va permettre de se remettre au travail beaucoup plus rapidement. Qui n'a jamais redécouvert un de ses propres codes au bout de quelques semaines sans comprendre comment il avait pu coder quelque chose d'aussi horrible/merveilleux ?
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
Cet article est réservé aux abonnés. Il vous reste 95% à découvrir.
S'abonner à Connect
- 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
Déjà abonné ? Connectez-vous