では「九九の表を出力する関数」に docstring(複数行コメント) をつけた例を紹介します。
九九の表を出力するプログラム(例)
def print_kuku():
"""
九九の表を出力する関数
- 1から9までの掛け算を表示する
- 横に並べて見やすく整形する
- 教材や練習問題に使える
"""
for i in range(1, 10): # 1の段から9の段まで
for j in range(1, 10): # 各段の掛け算
print(i * j, end="\t") # タブ区切りで横に並べる
print() # 段ごとに改行
# 関数を実行
print_kuku()
Python実行結果(イメージ)
1 2 3 4 5 6 7 8 9
2 4 6 8 10 12 14 16 18
3 6 9 12 15 18 21 24 27
...
9 18 27 36 45 54 63 72 81
💡 ポイント
""" ... """で囲んだ部分が docstring(関数の説明書)help(print_kuku)とすると、この説明が表示されます- コメントは「なぜこの処理をしているのか」を書くと読みやすい
👉 ここから練習として、例えば「足し算の表」や「三角形の形で九九を表示する関数」を作ってみると、docstringの使い方がもっと身につきますよ。
