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