En tant que programmeur ou apprenti programmeur, il est sans doute obligatoire d’avoir avec soi documentations de vos langages de programmation respectifs, cela est d’une grande aide pour obtenir une aide d’une fonction quelconque à utiliser. Pour cet exemple, je choisis Python comme référence à cela, mais cela dit, il est possible d’avoir des documentations d’autres langages que vous connaissez.

Documentation Python3 en ligne

Depuis la version récente de Python, il est possible d’être documenté. Afficher de l’aide sur une fonction pour comprendre son utilisation, par exemple. À vrai dire, cette nouvelle fonctionnalité est une nouvelle de python x uniquement.

Comment installer Python 3 et utiliser Docstrings

Si vous êtes sur une version antérieure de Python installé sur votre Ordinateur, il est temps de penser à être à jour en passant sur la version récente du langage. Sur Linux par exemple, il suffit d’installer Python 3 comme ceci :

sudo apt-get install python3

Comment installer Python 3 - Comment utiliser la documentation des fonctions sur Python3

Sur cette image, j’ai essayé d’installer Python 3, mais un message apparaît pour dire que la dernière version de Python est installée : « python3 is already the newest version ». 

Si vous êtes sur Windows, vous pouvez vous rendre sur le site officiel de Python, pour ce faire, voici donc le lien « python.org ».

Ces documentations sont communément appelées docstings. Vous pouvez y avoir accès depuis votre interpréteur Python en spécifiant la fonction dont a besoin d’afficher de l’aide ou encore depuis votre IDE (Interface de Développement Intégré), c’est comme vous voulez.

Comment demander une documentation en ligne sur les fonctions sur Python 3

Vous devez soit utiliser l’interpréteur Python ou votre IDE tout en vérifiant que c’est la version 3.x qui est en place. Normalement lorsque ce n’est pas la version 3 de python un message d’erreur apparaît « SyntaxError : invalid syntax ».

Pour afficher la documentation d’une fonction, il suffit de procéder comme suit depuis votre interpréteur :

print(fonction__doc₎

Il y a deux undescore qui se suivent.

Si vous êtes sur un IDE, moi j’utilise Spyder sur Linux, il suffit de trouver l’option qui permet d’afficher le bloc « Aide en ligne ». Affichage → Volets → Aide en ligne ou encore Ctrl + Maj + D. Dans l’IDE, on peut simplement écrire le nom de la fonction et la documentation sur cette dernière apparaîtra aussitôt. Voici donc une petite démonstration sur l’image ci-dessous :

Comment demander une documentation en ligne sur les fonctions sur Python 3 - Comment utiliser la documentation des fonctions sur Python3

Vous pouvez aussi vous documenter à l’aide du site de python (en anglais). Visitez Python Doc.

Et voilà, un article superbe pour les habitants du Monty Python. J’espère que cela vous aura plu et si c’est le cas, la manière dont je peux en être sûr c’est de partager sur les réseaux sociaux. Dites-moi en zone commentaire ce que vous pensez de cette nouveauté de Python 3.