En Python, utilisation #d’ajouter des descriptions en tant que commentaires ou de commenter un code inutile.
Observations concernant #
Observations en ligne
Tout vient de #à la fin de la ligne est ignorée lors de l’exécution. Code avant #reste valable.
a = 1 # comment
Si un commentaire en contient un autre #, tout après la première #est considéré comme faisant partie du même commentaire.
a = 1 # comment # b = 2
A #à l’intérieur d’une chaîne est traitée comme une #et ne pas considérer un commentaire.
s = 'abc # xyz'
Observations du bloc
En plaçant un #au début d’une ligne, l’ensemble de la ligne est considéré comme un commentaire et ignoré pendant l’exécution.
# a = 1
Bien sûr, si vous placez un #au début de chaque ligne dans un bloc, vous pouvez commenter plusieurs lignes.
a = 1
# b = 2
# c = 3
# d = 4
e = 5
Règles recommandées dans le PEP 8 (conventions de codage)
PEP est l’acronyme de Python Enhancement Proposal. PEP8 est un document qui décrit les conventions de codage (guide de style) pour Python. Règles recommandées pour les observations à l’aide #sont également décrites.
Le respect des règles du PEP8 n’est pas nécessaire pour éviter les erreurs de syntaxe, mais c’est une bonne idée d’adhérer au PEP8 lorsqu’il n’y a pas de conventions de codage spécifiques pour une organisation ou un projet.
Les règles d’écriture des commentaires, ainsi que les codes d’erreur correspondants utilisés par les vérificateurs de code tels que pydocstyle et flake8, sont présentés ci-dessous.
Observations en ligne
E261: au moins deux espaces avant commentaire en ligne
Placer au moins deux espaces avant le #dans un commentaire en ligne. Trois espaces ou plus sont également acceptables, mais seulement pour aligner les observations. Il convient d’éviter les espaces inutiles.
# No:
a = 1 # comment
# Yes:
a = 1 # comment
a = 1 # comment
xyz = 100 # comment
E262: le commentaire en ligne devrait commencer par ‘- ‘
Commencer un commentaire en ligne avec un seul espace après le #. Ne pas omettre l’espace et n’utiliser pas plus d’un espace.
# No:
a = 1 #comment
a = 1 # comment
# Yes:
a = 1 # comment
Observations du bloc
E265: le commentaire en bloc devrait commencer par ‘- ‘
Démarrer un commentaire de bloc avec un seul espace après le #à moins que le texte ne soit classé dans le commentaire. Ne pas omettre l’espace.
Contrairement à E262, deux espaces ou plus sont acceptables, mais seulement pour l’indentation dans le commentaire. Il convient d’éviter les espaces inutiles.
# No:
#comment
# Yes:
# comment
# indented comment
E266: trop de têtes de ‘z’ pour des commentaires de bloc
N’utiliser qu’un seul chef de file #.
# No:
## comment
# Yes:
# comment
Utiliser des cotations triples comme commentaires multilignes
Des docstrings peuvent être ajoutés au début d’une fonction ou d’une classe pour fournir des explications.
def test(a, b):
'''docstring
description
'''
print(a)
print(b)
Parce que les cotations triples (soit '''ou """) peuvent créer des chaînes multilignes, y compris des sauts de ligne, elles sont souvent utilisées pour les docstrings.
Parfois, des cotations triples sont utilisées pour des commentaires multilignes ou pour commenter un bloc.
a = 1
'''
b = 2
c = 3
d = 4
'''
e = 5
Cependant, gardez à l’esprit que les citations triples créent des chaînes, pas des commentaires, donc elles ne sont pas ignorées pendant l’exécution comme des commentaires avec #.
Par exemple, lorsque vous utilisez des cotations triples comme commentaires dans un bloc en retrait, vous devez vous assurer que le niveau d’indentation est cohérent, ou vous rencontrerez une erreur.
Si l’indentation est correctement appariée, le code fonctionnera.
def test(a, b):
print(a)
'''
comment line1
comment line2
comment line3
'''
print(b)
Si l’indentation est incorrecte, vous obtiendrez un IndentationError.
def test(a, b):
print(a)
'''
comment line1
comment line2
comment line3
'''
print(b)
# IndentationError: unexpected indent
Commentaires utilisant #sont ignorés pendant l’exécution, de sorte que l’indentation incorrecte ne provoquera pas d’erreur. Cependant, pour une meilleure lisibilité du code, il est recommandé de maintenir des niveaux d’indentation cohérents.
def test(a, b):
print(a)
# comment line1
# comment line2
# comment line3
print(b)
def test(a, b):
print(a)
# comment line1
# comment line2
# comment line3
print(b)
Quoi qu’il en soit, puisque les citations triples créent des chaînes plutôt que des commentaires réels, il est plus sûr d’éviter de les utiliser comme commentaires en dehors des docstrings.
Des éditeurs comme VS Code utilisent #pour les commentaires à la fois uniques et multilignes lors de l’utilisation du raccourci de commentaire ( command + /ou control + /).
Observations accompagnées d’annotations de fonctions
Depuis Python 3.0, les annotations de fonction peuvent être utilisées pour ajouter des annotations, telles que des informations de type ou des descriptions, pour fonctionr les arguments et les valeurs de retour.
def func_annotations_type(x: str, y: int) -> str:
return x * y
Les annotations de fonction servent de notes, et la spécification d’un type n’impose pas la vérification de type pendant l’exécution. Cependant, certains IDE et éditeurs peuvent utiliser ces informations à diverses fins.