Existe-t-il un moyen de créer des commentaires multilignes en Python?

J'ai récemment commencé à étudier Python , mais je n'ai pas trouvé comment implémenter les commentaires sur plusieurs lignes. La plupart des langues ont des symboles de commentaire de bloc comme

/*

*/

J'ai essayé cela en Python, mais cela génère une erreur, donc ce n'est probablement pas la bonne façon. Python a-t-il réellement une fonction de commentaire multiligne?

Vous pouvez utiliser des chaînes entre guillemets triples. Quand ils ne sont pas une docstring (la première chose dans une classe / fonction / module), ils sont ignorés.

'''
This is a multiline
comment.
'''

(Assurez-vous de bien mettre en retrait le '''début pour éviter un IndentationError.)

Guido van Rossum (créateur de Python) a tweeté cela comme un "conseil pro".

Cependant, le guide de style de Python, PEP8, privilégie l'utilisation de commentaires consécutifs sur une seule ligne , et c'est également ce que vous trouverez dans de nombreux projets. Les éditeurs de texte ont généralement un raccourci pour le faire facilement.

Python a une syntaxe de chaîne / commentaire multiligne dans le sens où, sauf si elles sont utilisées comme docstrings, les chaînes multilignes ne génèrent aucun bytecode - tout comme les #commentaires pré-préparés. En effet, il agit exactement comme un commentaire.

D'un autre côté, si vous dites que ce comportement doit être documenté dans la documentation officielle pour être une véritable syntaxe de commentaire, alors oui, vous auriez raison de dire qu'il n'est pas garanti dans le cadre de la spécification du langage.

Dans tous les cas, votre éditeur de texte devrait également pouvoir facilement commenter une région sélectionnée (en plaçant un #devant chaque ligne individuellement). Sinon, passez à un éditeur de texte qui le fait.

La programmation en Python sans certaines fonctionnalités d'édition de texte peut être une expérience douloureuse. Trouver le bon éditeur (et savoir comment l'utiliser) peut faire une grande différence dans la façon dont l'expérience de programmation Python est perçue.

Non seulement l'éditeur de texte doit pouvoir mettre en commentaire des régions sélectionnées, mais il doit également pouvoir déplacer facilement des blocs de code vers la gauche et la droite, et il doit automatiquement placer le curseur au niveau de retrait actuel lorsque vous appuyez sur Enter. Le pliage de code peut également être utile.

Pour se protéger contre la décomposition des liens, voici le contenu du tweet de Guido van Rossum :

@BSUCSClub Astuce Python: vous pouvez utiliser des chaînes multilignes comme commentaires multilignes. À moins qu'ils ne soient utilisés comme docstrings, ils ne génèrent aucun code! :-)

De la réponse acceptée ...

Vous pouvez utiliser des chaînes entre guillemets triples. Quand ils ne sont pas une docstring (première chose dans une classe / fonction / module), ils sont ignorés.

Ce n'est tout simplement pas vrai. Contrairement aux commentaires, les chaînes entre guillemets triples sont toujours analysées et doivent être syntaxiquement valides, quel que soit leur emplacement dans le code source.

Si vous essayez d'exécuter ce code ...

def parse_token(token):
    """
    This function parses a token.
    TODO: write a decent docstring :-)
    """

    if token == '\\and':
        do_something()

    elif token == '\\or':
        do_something_else()

    elif token == '\\xor':
        '''
        Note that we still need to provide support for the deprecated
        token \xor. Hopefully we can drop support in libfoo 2.0.
        '''
        do_a_different_thing()

    else:
        raise ValueError

Vous aurez soit ...

ValueError: invalid \x escape

... sur Python 2.x ou ...

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 79-80: truncated \xXX escape

... sur Python 3.x.

La seule façon de faire des commentaires sur plusieurs lignes qui sont ignorés par l'analyseur est ...

elif token == '\\xor':
    # Note that we still need to provide support for the deprecated
    # token \xor. Hopefully we can drop support in libfoo 2.0.
    do_a_different_thing()

En Python 2.7, le commentaire multiligne est:

"""
This is a
multilline comment
"""

Si vous êtes dans une classe, vous devez la tabuler correctement.

Par exemple:

class weather2():
   """
   def getStatus_code(self, url):
       world.url = url
       result = requests.get(url)
       return result.status_code
   """

AFAIK, Python n'a pas de commentaire de bloc. Pour commenter des lignes individuelles, vous pouvez utiliser le #caractère.

Si vous utilisez Notepad ++ , il existe un raccourci pour les commentaires de bloc . Je suis sûr que d'autres comme gVim et Emacs ont des fonctionnalités similaires.

Je pense que ce n'est pas le cas, sauf qu'une chaîne multiligne n'est pas traitée. Cependant, la plupart, sinon tous les IDE Python ont une touche de raccourci pour «commenter» plusieurs lignes de code.

Si vous mettez un commentaire dans

"""
long comment here
"""

au milieu d'un script, Python / linters ne reconnaîtra pas cela. Le pliage sera foiré, car le commentaire ci-dessus ne fait pas partie des recommandations standard. Il vaut mieux utiliser

# Long comment
# here.

Si vous utilisez Vim , vous pouvez utiliser des plugins comme commentary.vim , pour commenter automatiquement de longues lignes de commentaires en appuyant sur Vjgcc. Où Vjsélectionne deux lignes de code et les gcccommente.

Si vous ne voulez pas utiliser des plugins comme ci-dessus, vous pouvez utiliser la recherche et le remplacement comme

:.,.+1s/^/# /g

Cela remplacera le premier caractère de la ligne actuelle et suivante par #.

Il n'existe pas de fonctionnalité telle qu'un commentaire sur plusieurs lignes. #est le seul moyen de commenter une seule ligne de code. Beaucoup d'entre vous ont répondu '' 'un commentaire' '' comme solution.

Cela semble fonctionner, mais en interne '''en Python prend les lignes jointes comme des chaînes régulières que l'interpréteur n'ignore pas comme l'utilisation des commentaires #.

Consultez la documentation officielle ici

Malheureusement, la stringification ne peut pas toujours être utilisée comme commentaire! Il est donc plus sûr de s'en tenir à la norme avant chaque ligne avec un #.

Voici un exemple:

test1 = [1, 2, 3, 4,]       # test1 contains 4 integers

test2 = [1, 2, '''3, 4,'''] # test2 contains 2 integers **and the string** '3, 4,'

Eh bien, vous pouvez essayer ceci (lors de l'exécution de la citation, l'entrée de la première question doit être citée avec '):

"""
print("What's your name? ")
myName = input()
print("It's nice to meet you " + myName)
print("Number of characters is ")
print(len(myName))
age = input("What's your age? ")
print("You will be " + str(int(age)+1) + " next year.")

"""
a = input()
print(a)
print(a*5)

Tout ce qui est joint entre """sera commenté.

Si vous recherchez des commentaires sur une seule ligne, c'est le cas #.

Commentaire multiligne en Python:

Pour moi, "" "et" "" ont fonctionné.

Exemple:

a = 10
b = 20
c = a+b
'''
print ('hello')
'''
print ('Addition is: ', a+b)

Exemple:

a = 10
b = 20
c = a+b
"""
print('hello')
"""
print('Addition is: ', a+b)

Les commentaires en ligne en Python commencent par un caractère de hachage.

hello = "Hello!" # This is an inline comment
print(hello)

salut!

Notez qu'un caractère de hachage dans un littéral de chaîne n'est qu'un caractère de hachage.

dial = "Dial #100 to make an emergency call."
print(dial)

Composez le # 100 pour passer un appel d'urgence.

Un caractère de hachage peut également être utilisé pour les commentaires sur une ou plusieurs lignes.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

Bonjour

Monde

Mettez le texte entre guillemets doubles pour prendre en charge la docstring.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

Bonjour John!

Entourez le texte de triples guillemets simples pour les commentaires de bloc.

'''
I don't care the parameters and
docstrings here.
'''

Sur Python 2.7.13:

Célibataire:

"A sample single line comment "

Multiligne:

"""
A sample
multiline comment
on PyCharm
"""

Bascule de commentaire multi-ligne officielle universelle de Visual Studio Code .

macOS: sélectionnez le bloc de code, puis ⌘+/

Windows: sélectionnez le bloc de code, puis Ctrl+/

Oui, c'est bien d'utiliser les deux:

'''
Comments
'''

et

"""
Comments
"""

Mais, la seule chose dont vous devez tous vous souvenir lors de l'exécution dans un IDE, c'est que vous devez exécuter le fichier entier pour être accepté en tant que codes de lignes multiples. Ligne par ligne 'RUN' ne fonctionnera pas correctement et affichera une erreur.

Pour commenter plusieurs lignes de code en Python, il suffit d'utiliser un #commentaire d' une seule ligne sur chaque ligne:

# This is comment 1
# This is comment 2 
# This is comment 3

Pour écrire des commentaires multilignes «corrects» en Python, il faut utiliser des chaînes multilignes avec la """syntaxe Python a la fonctionnalité de chaînes de documentation (ou docstrings). Il permet aux programmeurs d'ajouter facilement des notes rapides à chaque module, fonction, classe et méthode Python.

'''
This is
multiline
comment
'''

Notez également que vous pouvez accéder à docstring par un objet de classe comme celui-ci

myobj.__doc__

Vous pouvez utiliser ce qui suit. Cela s'appelle DockString.

def my_function(arg1):
    """
    Summary line.
    Extended description of function.
    Parameters:
    arg1 (int): Description of arg1
    Returns:
    int: Description of return value
    """
    return arg1

print my_function.__doc__

Je déconseille d'utiliser """pour les commentaires sur plusieurs lignes!

Voici un exemple simple pour mettre en évidence ce qui pourrait être considéré comme un comportement inattendu:

print('{}\n{}'.format(
    'I am a string',
    """
    Some people consider me a
    multi-line comment, but
    """
    'clearly I am also a string'
    )
)

Jetez maintenant un œil à la sortie:

I am a string

    Some people consider me a
    multi-line comment, but
    clearly I am also a string

La chaîne de plusieurs lignes n'a pas été traitée comme un commentaire, mais elle a été concaténée avec 'clearly I'm also a string'pour former une seule chaîne.

Si vous souhaitez commenter plusieurs lignes, faites-le conformément aux directives PEP 8 :

print('{}\n{}'.format(
    'I am a string',
    # Some people consider me a
    # multi-line comment, but
    'clearly I am also a string'
    )
)

Production:

I am a string
clearly I am also a string

Utilisation de PyCharm IDE.

Vous pouvez commentet des uncommentlignes de code en utilisant Ctrl + /. Ctrl + / commente ou décommente la ligne actuelle ou plusieurs lignes sélectionnées avec des commentaires d'une seule ligne ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/pour un bloc de code source sélectionné dans un modèle Django entoure le bloc de {% comment %} and {% endcomment %}balises.

---

n = 5
while n > 0:
    n -= 1
    if n == 2:
        break
    print(n)

print("Loop ended.")

Sélectionnez toutes les lignes puis appuyez sur Ctrl + /

# n = 5
# while n > 0:
#     n -= 1
#     if n == 2:
#         break
#     print(n)

# print("Loop ended.")

Un commentaire multiligne n'existe pas réellement en Python. L'exemple ci-dessous se compose d'une chaîne non affectée, qui est validée par Python pour les erreurs syntaxiques.

Quelques éditeurs de texte, comme Notepad ++ , nous fournissent des raccourcis pour commenter un morceau de code ou des mots écrits.

def foo():
    "This is a doc string."
    # A single line comment
    """
       This
       is a multiline
       comment/String
    """
    """
    print "This is a sample foo function"
    print "This function has no arguments"
    """
    return True

De plus, Ctrl+ Kest un raccourci dans Notepad ++ pour bloquer les commentaires. Il ajoute un #devant chaque ligne sous la sélection. Ctrl+ Shift+ Kcorrespond à la décommentation de bloc.

Entre autres réponses, je trouve que le moyen le plus simple est d'utiliser les fonctions de commentaire IDE qui utilisent le support de commentaire Python de #.

J'utilise Anaconda Spyder et il a:

• Ctrl+ 1- Commentaire / décommentation
• Ctrl+ 4- Commentez un bloc de code
• Ctrl+ 5- Décommentez un bloc de code

Il commenterait / décommenterait une / plusieurs ligne (s) de code avec #.

Je trouve ça le plus simple.

Par exemple, un commentaire de bloc:

# =============================================================================
#     Sample Commented code in spyder
#  Hello, World!
# =============================================================================

Sélectionnez les lignes que vous souhaitez commenter, puis utilisez Ctrl+ ?pour commenter ou décommenter le code Python dans l' éditeur de texte sublime .

Pour une seule ligne, vous pouvez utiliser Shift+ #.