ブロックコメント
Coddyの「Clean Code - Pythonでより良いコードを書く」コースのレッスン 6/28。
「実装を説明するのが難しいなら、それは悪い考えです。」
- Pythonの禅
コメントは、コードを読む人が誰でもその内容を理解できるようにするために重要です。
Pythonのコメントは3種類に分かれます:
- ブロックコメント
- インラインコメント
- ドキュメンテーション文字列
まずはブロックコメントから始めましょう -
- 説明するコードと同じインデントのブロックから始めます。
- 各行を
#に続く1つのスペースで始めます。
例えば、
while i < 10:
# i が i < 10 になるまでループする
# i を改行付きで出力し、1 増やす
print(i, '\n')
i += 1チャレンジ
簡単greet関数が与えられています。この関数が何をするのかを、自分の言葉で説明するブロックコメントを書いてください。
ルールに従ってください!
自分で試してみよう
def greet(name):
print('Hello', name)Clean Code - Pythonでより良いコードを書くのすべてのレッスン
自分で練習してみよう: Pythonオンラインコンパイラ