PEP 8 dans la documentation
Jusqu’ici, nous nous sommes concentrés sur l’impact de PEP 8 sur les parties fonctionnelles du code. Il existe aussi des règles pour rendre les commentaires et la documentation plus lisibles. Dans cet exercice, vous allez corriger différents types de commentaires pour qu’ils soient conformes à PEP 8.
Le résultat d’une vérification de style pycodestyle sur le code est présenté ci-dessous.
my_script.py:2:15: E261 at least two spaces before inline comment
my_script.py:5:16: E262 inline comment should start with '# '
my_script.py:11:1: E265 block comment should start with '# '
my_script.py:13:2: E114 indentation is not a multiple of four (comment)
my_script.py:13:2: E116 unexpected indentation (comment)
Cet exercice fait partie du cours
Principes d’ingénierie logicielle en Python
Instructions
- Appuyez-vous sur la sortie de
pycodestylepour modifier les commentaires du code et les rendre conformes à PEP 8.
Exercice interactif pratique
Essayez cet exercice en complétant cet exemple de code.
def print_phrase(phrase, polite=True, shout=False):
if polite:# It's generally polite to say please
phrase = 'Please ' + phrase
if shout: #All caps looks like a written shout
phrase = phrase.upper() + '!!'
print(phrase)
#Politely ask for help
print_phrase('help me', polite=True)
# Shout about a discovery
print_phrase('eureka', shout=True)