Comment commenter un bloc de code en Python ?

Existe-t-il un mécanisme permettant de commenter de gros blocs de code Python ?

Pour l'instant, les seuls moyens que je vois pour commenter du code sont soit de commencer chaque ligne par un #, soit de mettre le code entre trois guillemets : """.

Le problème avec ces méthodes est que l'insertion de # avant chaque ligne est encombrante et que `"""`` fait apparaître la chaîne que je veux utiliser comme commentaire dans la documentation générée.

Après avoir lu tous les commentaires, la réponse semble être "No&quot ;.

Solution

Python ne dispose pas d'un tel mécanisme. Préparez un # à chaque ligne pour bloquer le commentaire. Pour plus d'informations, voir [PEP 8][1]. La plupart des IDEs Python supportent un mécanisme pour faire le block-commenting-with-pound-signs automatiquement pour vous. Par exemple, dans IDLE sur ma machine, c'est Alt+3 et Alt+4.

N'utilisez pas de guillemets triples; comme vous l'avez découvert, il s'agit de chaînes de documentation et non de commentaires de bloc, bien que cela ait un effet similaire. Si vous ne faites que commenter temporairement des choses, cette mesure temporaire est acceptable.

[1] : http://www.python.org/dev/peps/pep-0008/

Commentaires (30)

Le seul remède que je connaisse pour ça est un bon éditeur. Désolé.

Commentaires (2)

La seule façon de le faire sans guillemets est d'ajouter un :

if False:

Et d'indenter tout votre code. Notez que le code devra toujours avoir une syntaxe correcte.


De nombreux IDEs Python peuvent ajouter des # pour vous sur chaque ligne sélectionnée, et les supprimer lors du dé-commentaire également. De même, si vous utilisez [vi][1] ou [Emacs][2], vous pouvez créer une macro qui fera cela pour vous pour un bloc de code.

[1] : http://en.wikipedia.org/wiki/Vi [2] : http://en.wikipedia.org/wiki/Emacs

Commentaires (5)