Les différents types de commentaires
Inscris-toi
(c'est gratuit !)
Un compte est nécessaire pour participer aux discussions.
Créer un compte00:00:00 :Si vous vous souvenez bien, on a vu au tout début de la formation comment commenter des lignes de code,c'est-à-dire ajouter un commentaire qui explique ce qu'une ligne de code fait sans que Python essaye de l'exécuter.
00:00:11 :Pour commenter du code, on peut utiliser le symbole dièse pour une seule ligne et trois guillemets pour un bloc de lignes.Dans les prochaines parties, on va regarder de plus près tout ça et notamment les endroits dans notre script où l'on écrit généralement des commentaires,on peut en effet commenter beaucoup de choses.
00:00:27 :Ça peut aller de la simple ligne de code à une fonction, voire carrément à commenter un module au complet.Quand on ajoute des commentaires dans des structures comme les fonctions ou les modules,on va pouvoir récupérer ces commentaires sous forme de documentation afin de donner des informations à l'utilisateur sur comment utiliser notre fonction ou module.
00:00:46 :Dans ce cas-là, on parle donc d'une documentation string qu'on retrouve souvent sous son nom abrégé de docstring.Ces docstrings, si elles sont placées au bon endroit et avec la bonne syntaxe, Python va pouvoir les récupérer automatiquement.
00:00:58 :Il existe même des modules Python qui permettent de générer une documentation complète automatiquement grâce au docstring.Dans la prochaine partie, on va voir les différents formats de docstring disponibles pour pouvoir générer une documentation automatique avec Python et Visual Studio Code.
Ce n'est pas fini...
✋
Tu as complété % du parcours 🔥
Termine l'intégralité de la formation pour pouvoir débloquer ton attestation de réussite.
