문서에서의 PEP 8
지금까지는 PEP 8이 코드의 기능적 부분에 어떤 영향을 미치는지에 집중했어요. 주석과 문서화를 더 읽기 쉽게 만드는 규칙도 있어요. 이 연습에서는 다양한 형태의 주석을 PEP 8 규칙에 맞도록 고쳐 보겠습니다.
아래는 코드에 대해 pycodestyle 스타일 검사를 실행한 결과예요.
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)
이 연습은 강의의 일부입니다
Python으로 배우는 소프트웨어 공학 원칙
연습 안내
pycodestyle출력 결과를 참고해 코드의 주석을 PEP 8에 맞도록 수정하세요.
실습형 인터랙티브 연습
이 예제를 이 샘플 코드를 완성하여 풀어보세요.
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)