Comment commenter un bloc de code dans Python
Existe-t-il un mécanisme permettant de commenter les gros blocs de code Python?
Pour le moment, les seuls moyens de commenter le code sont de commencer chaque ligne avec un # ou de placer le code entre guillemets: """.
Le problème avec ceux-ci est que l'insertion de # avant chaque ligne est fastidieuse et que """ rend la chaîne que je souhaite utiliser comme commentaire affichée dans la documentation générée.
Après avoir lu tous les commentaires, la réponse semble être "Non".
Python n'a pas un tel mécanisme. Ajoutez un # à chaque ligne pour bloquer les commentaires. Pour plus d'informations, voir PEP 8 . La plupart des Python IDE prennent en charge un mécanisme permettant de faire automatiquement les commentaires de blocage de dièse pour vous. Par exemple, dans IDLE sur ma machine, c’est Alt+3 et Alt+4.
N'utilisez pas de triple-guillemets; comme vous l'avez découvert, il s'agit de chaînes de documentation qui ne bloquent pas les commentaires, bien que cela ait un effet similaire. Si vous ne commentez que temporairement, c'est une mesure temporaire.
Le seul remède que je connaisse pour cela est un bon éditeur. Pardon.
Cachez les triples guillemets dans un contexte qui ne sera pas confondu avec un docstring, par exemple:
'''
...statements...
''' and None
ou:
if False: '''
...statements...
'''
La seule façon de faire cela sans les guillemets triples est d’ajouter un:
if False:
Et puis indenter tout votre code. Notez que le code devra toujours avoir la syntaxe appropriée.
De nombreux Python IDE peuvent ajouter # pour vous sur chaque ligne sélectionnée et les supprimer lors de la suppression de commentaires. De même, si vous utilisez vi ou Emacs , vous pouvez créer une macro pour le faire pour vous pour un bloc de code.
M-x comment-region, en mode Emacs 'Python.
Dans JetBrains PyCharm sur Mac utiliser Command + / commenter/retirer le commentaire du bloc de code sélectionné. Sous Windows, utilisez CTRL + /.
Au moins dans VIM, vous pouvez sélectionner la première colonne de texte à insérer en mode de blocage visuel (CTRL+V dans des VIM autres que Windows), puis ajouter un # avant chaque ligne. en utilisant cette séquence:
I#<esc>
En mode bloc visuel I passe en mode insertion avec le curseur avant le bloc sur sa première ligne. Le texte inséré est copié avant chaque ligne dans le bloc.
Dans vi :
- Allez en haut du bloc et marquez-le avec la lettre a.
- Aller au bas du bloc et le marquer avec la lettre b
Alors fais
:'a,'b s!^!#!
comm='''
Junk, or working code
that I need to comment.
'''
Vous pouvez remplacer comm par une variable de votre choix, peut-être plus courte, facile à saisir au toucher, et vous savez que cela ne se produit pas (et ne se produira pas) dans vos programmes. Exemples: xxx, oo, null, nil.
Oui, il y en a (selon votre éditeur). Dans PyDev (et dans Aptana Studio avec PyDev):
Ctrl + 4 - commenter le bloc sélectionné
Ctrl + 5 - supprimer le commentaire du bloc sélectionné
Dans Visual Studio, à l'aide de Outils Python pour Visual Studio , les blocs peuvent être commentés par Ctrl+K, Ctrl+C et non commenté par Ctrl+K, Ctrl+U.
J'utilise Notepad ++ sur une machine Windows, sélectionnez votre code, tapez CTRL-K. Pour supprimer le commentaire, sélectionnez le code et appuyez sur Ctrl + Shift + K.
Incidemment, Notepad ++ fonctionne bien comme un éditeur Python. Avec l'auto-complétion, le pliage de code, la coloration syntaxique et bien plus encore. Et c'est gratuit comme dans le discours et comme dans la bière!
Le seul mécanisme permettant de commenter le code Python (compris comme un code ignoré par l'interpréteur) est le # .
Comme vous le dites, vous pouvez également utiliser littéraux de chaîne , qui ne sont pas ignorés par l'interpréteur, mais peuvent être totalement inutiles pour l'exécution du programme.
Les citations triples me conviennent. Vous pouvez utiliser '' 'foo' '' pour docstrings et "" "bar" "" pour les commentaires ou vice-versa pour rendre le code plus lisible.
Sur Eric4, il existe un moyen simple: sélectionnez un bloc, tapez Ctrl+M commenter l'ensemble du bloc ou Ctrl+alt+M décommenter.
Une autre solution basée sur l'éditeur: le texte "rectangles" dans Emacs.
Mettez en surbrillance le code que vous voulez commenter, puis C-x-r-t #
Pour commenter le code: mettez en surbrillance, puis C-x-r-k
Je l'utilise toute la journée, tous les jours. (Attribué aux touches de raccourci, bien sûr.)
C’est la raison pour laquelle je tolère les autres "excentricités" d’Emacs, grâce à cette puissante et efficace recherche/remplacement de regex.
Utilisez un éditeur Nice tel que SciTe , sélectionnez votre code, appuyez sur Ctrl + Q et fait.
Si vous ne disposez pas d'un éditeur prenant en charge les commentaires de bloc, vous pouvez utiliser une chaîne à triple guillemet au début et à la fin de votre bloc de code pour la commenter efficacement. Ce n'est pas la meilleure pratique cependant.