Docstrings#
Important
Tout en étant le plus proche de la documentation officielle, ces notes sont rédigées pour des projets personnels. En fonction des besoins, il faut se rendre sur la documentation officielle et adapter les paramétrages car ces notes ne les substituent google , numpy/scipy ou Sphinx.
Qu’est ce que les docstrings#
💡 Les docstrings Python sont des chaînes de documentation qui sont incorporées directement dans le code source d’une fonction, d’une classe ou d’un module. Ils sont utilisés pour fournir des informations claires et concises sur le but auquel ils sont associés. Les docstrings sont accessibles via l’attribut _doc_ de l’objet concerné et sont utilisés pour générer automatiquement une documentation plus détaillée à l’aide d’outils tels que Sphinx.
Ces styles docstring permettent aux développeurs de comprendre rapidement comment utiliser une fonction ou une classe sans avoir à examiner le code source, ce qui facilite la collaboration et la maintenance du code.
Il existe plusieurs styles de docstrings en Python, mais deux des plus courants sont: