Configurer Visual Studio Code pour les commentaires
Inscris-toi
(c'est gratuit !)
Un compte est nécessaire pour participer aux discussions.
Créer un compteToutes les questions
Frederic SEEMANN
26 janvier 2025
Résolue
1 réponse
Mise en forme de code dans les paramètres de VS Code
Hello, dans mes paramètres de VS Code, je retrouve l'extension autoDocstring dans les paramètres sous le nom `"Python Docstring Generator configuration"`.
Marc
28 mars 2024
Résolue
2 réponses
Impossible d'insérer automatiquement le bloc commentaire selon la méthode indiquée dans la vidéo
Bonjour,
Lorsque j'ajoute un guillemet, il m'en rajoute un 2ième automatiquement. Si j'en ajoute un 3ième, il en affiche en tout 6... J'en ai donc retiré 3 pour ensuite faire "Enter" mais il ne se passe rien.
Du coup, j'ai été voir les raccourcis clavier. En tapant CTS+MAJ+é cela fonctionne.
Toutefois ta méthode me semble plus simple à utiliser au quotidien. Aurais-tu une idée de la raison pour laquelle cela ne fontionne pas sur mon VS Code ?
Merci
00:00:00 :Dans cette partie, on va voir comment configurer Visual Studio Codeafin de pouvoir insérer facilement des docstrings à l'intérieur de notre code.On va aller dans les extensions.
00:00:10 :Vous allez dans Préférences, vous affichez les extensionset on va chercher à l'intérieur de la barre de recherche une extension qui s'appelle AutoDocString.Vous tapez AutoDocString tout attaché dans la barre de recherche.
00:00:21 :Vous avez une extension ici qui apparaît, c'est celle-ci.On va cliquer sur Install pour l'installer.Une fois qu'elle est installée, on va pouvoir aller modifier quelques paramètresdans les préférences de Visual Studio Code.
00:00:33 :Pour ça, on va aller dans les préférences de VS Code.Dans Préférences ici, vous allez dans Settings, paramètres en françaiset on va avoir ici une catégorie Extensionset on devrait retrouver notre extension que l'on a installée.
00:00:47 :Si jamais vous ne la voyez pas, vous pouvez tout simplement redémarrer Visual Studio Codeet elle devrait apparaître ici.On va changer juste une petite chose ici.
00:00:56 :Par défaut, vous devez avoir le Settings défaut qui est affiché.Nous, on va utiliser la syntaxe de Google.Je clique tout simplement ici dans DocString Format sur Googlepour mettre cette syntaxe par défaut dans les DocString.
00:01:10 :Je ferme les paramètres et ici, j'ai une fonction Test qui va me permettre de testeret d'insérer un DocString grâce à cette extension.Pour insérer un DocString à l'intérieur de cette fonction, c'est très facile.
00:01:22 :Il suffit de mettre trois guillemets, vous appuyez sur Entréeet automatiquement, vous avez l'extension qui vous formate tout le DocString comme il faut.On peut commencer par mettre une description de la fonction.
00:01:33 :Je vais mettre ici tout simplement Description de la fonctionet si on appuie sur Tab, à chaque fois, ça va naviguer entre les différents éléments que l'on peut changer.
00:01:41 :On a bien nos différents paramètres avec le nom tout d'abordet entre les parenthèses, on va indiquer le type de variable qu'on veut envoyer à ce paramètre.
00:01:49 :Dans ce cas-ci, ça va être une chaîne de caractères, donc je vais mettre str entre les parenthèses.On met la description, donc on va mettre par exemple le nom d'utilisateur.
00:01:59 :On appuie encore sur Tab pour aller sur l'âge.L'âge, ça va être un nombre entier, donc je mets int et je vais mettre l'âge de l'utilisateur.
00:02:07 :Ensuite, on va aller sur le Returns et le Returns, on va indiquer en premier lieu le type de ce qu'on va retourner.Dans ce cas-ci, ça va être une liste et on va mettre la description.
00:02:18 :Je vais mettre par exemple liste de nombre, tout simplement.C'est un exemple un peu abstrait, mais vous voyez qu'automatiquement,le Dockstring est bien formaté selon la syntaxe de Google, ce que je vous avais montré dans la partie précédente.
00:02:31 :Comme ça, on n'a pas besoin de se souvenir à chaque fois de toutes les petites choses comme ça ici,comme le Args ou le Returns qu'il faut mettre dans notre Dockstring.
00:02:40 :On a tout qui est bien formaté automatiquement.Si jamais vous voulez utiliser une autre syntaxe, vous pouvez la choisir et l'acéter par défaut dans les préférences.
00:02:48 :Moi, je préfère utiliser cette syntaxe de Google.Voilà comment insérer rapidement et facilement des Dockstrings à l'intérieur de votre codegrâce à l'extension AutoDockstring dans Visual Studio Code.
00:02:59 :Si jamais vous utilisez un autre éditeur de texte, il y a généralement des extensions de ce typepour chaque éditeur de texte, que ce soit Sublime Text ou PyCharm.
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.
