ドキュメンテーションにおける 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で学ぶSoftware Engineeringの原則
演習の手順
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)