Comment faire des commentaires sur un bloc de code en Python [double]

StackOverflow https://stackoverflow.com/questions/675442

  •  21-08-2019
  •  | 
  •  

Question

    

Cette question a déjà une réponse ici:

         

Y at-il un mécanisme permettant de commenter les grands blocs de code Python?

En ce moment, les seuls moyens que je peux voir que commenter le code sont soit commencer chaque ligne avec un #, ou pour joindre le code entre trois guillemets. """

Le problème avec ces derniers est que l'insertion avant chaque ligne <=> est lourd et fait la chaîne <=> je veux utiliser comme afficher le commentaire dans la documentation générée.

Après avoir lu tous les commentaires, la réponse semble être « Non ».

Était-ce utile?

La solution

Python ne dispose pas d'un tel mécanisme. Un préfixer par à chaque ligne # pour bloquer commentaire. Pour plus d'informations, consultez PEP 8 . La plupart Python IDEs soutiennent un mécanisme pour faire le bloc-commentant avec livres-signes automatiquement pour vous. Par exemple, en IDLE sur ma machine, il est Alt + 3 et Alt + 4 .

Ne pas utiliser triple guillemets; que vous avez découvert, c'est pour les chaînes de documentation ne bloque pas les commentaires, même si elle a un effet similaire. Si vous êtes juste de commenter les choses temporairement, cela est bien beau comme une mesure temporaire.

Autres conseils

Le seul remède que je sais pour cela est un bon éditeur. Pardon.

Masquer 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 que vous pouvez le faire sans triples guillemets est d'ajouter un: 

if False:

Et puis tout indentent votre code. Notez que le code sera toujours nécessaire d'avoir une syntaxe correcte.

De nombreux IDE Python peuvent ajouter pour vous sur # chaque ligne sélectionnée, et les enlever quand un-commentant aussi. 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 commentaire-région, dans « le mode de python Emacs.

Dans JetBrains PyCharm sur Mac utiliser Commande + / pour commenter / décommenter bloc de code sélectionné. Sous Windows, utilisez CTRL + / .

Au moins VIM, vous pouvez sélectionner la première colonne de texte que vous souhaitez insérer avec bloc en mode visuel (non dans CTRL+V fenêtres VIM) puis préfixer un avant chaque ligne # utilisant cette séquence: 

I#<esc>

Dans le bloc mode Visuel I se déplace 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.

vi :

  • Aller en haut du bloc et le marquer par la lettre a.
  • Aller en bas du bloc et le marquer par la lettre b

Ensuite, faites 

:'a,'b s!^!#!

comm='''
Junk, or working code 
that I need to comment.
'''

Vous pouvez remplacer par une variable comm de votre choix qui est peut-être plus court, facile à toucher type, et vous savez ne pas (et ne sera pas) se produire dans vos programmes. Exemples:. xxx, oo, null, nil

Oui, il y a (en fonction de votre éditeur). PyDev (et Aptana studio avec PyDev):

  • Ctrl + 4 - commenter bloc sélectionné

  • Ctrl + 5 - uncomment bloc sélectionné

Dans Visual Studio en utilisant les Outils Python Visual Studio, les blocs peuvent être commentés par Ctrl + K , Ctrl + C et uncommented par Ctrl + K , Ctrl + U .

Eclipse + PyDev , bloc Python commentaires est similaire à Eclipse bloc Java commentaires; sélectionnez les lignes que vous souhaitez commenter et utiliser Ctrl + / pour commenter. Pour décommenter un bloc commenté, faire la même chose.

J'utilise Notepad ++ sur une machine Windows, sélectionnez votre code, le type CTRL-K. Pour vous décommentez sélectionnez le code et appuyez sur Ctrl + Maj + K .

Par ailleurs, Notepad ++ fonctionne bien comme un éditeur Python. Avec l'auto-complétion, pliage de code, coloration syntaxique, et bien plus encore. Et il est libre comme dans la parole et comme dans la bière!

Le seul mécanisme pour commenter le code Python (compris code ignoré par l'interpréteur) est le # .

Comme vous le dites, vous pouvez aussi utiliser littéraux chaîne , qui ne sont pas ignorés par l'interprète, mais peut être tout à fait hors de propos pour l'exécution du programme.

Eclipse utilisant PyDev , vous pouvez sélectionner un bloc de code et appuyez sur Ctrl + # .

Les triples guillemets sont OK pour moi. Vous pouvez utiliser « » « toto « » » pour docstrings et « » « bar « » » des commentaires ou vice-versa pour rendre le code plus lisible.

Une autre solution avec l'éditeur: texte "rectangles" dans Emacs.

Mettez en surbrillance le code que vous voulez commenter, puis # C-x-r-t

Pour Décommentez le code: mettre en évidence, puis C-x-r-k

J'utilise cette toute la journée, tous les jours. (Affectées aux touches chaudes, bien sûr.)

et puissant moteur de recherche regex / remplacer est la raison pour laquelle je tolère les autres « excentricités ».

de Emacs

Sur eric4 il existe un moyen simple: sélectionnez un bloc, tapez Ctrl + M pour commenter le bloc entier ou Ctrl + alt + M pour uncomment.

Utilisez un éditeur de Nice comme SciTe , sélectionnez votre code, appuyez sur Ctrl + Q et fait.

Si vous ne disposez pas d'un éditeur qui prend en charge les commentaires de blocs que vous pouvez utiliser une chaîne entre guillemets triple au début et à la fin de votre bloc de code pour commenter « efficacement » it out. Il n'est pas la meilleure pratique cependant.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top