コメントはプログラムの中に含めることのできるメモのような存在であり,コードの意味を伝えたりするために利用されます.コメントがないソースコードは,たとえ自分で書いたものであっても数日から数週間後には自分でも意味がわからなくなります.コメントを残すことで,コードの意味や使用法などを後で(あるいは他人が)見て理解できるようになります.コメントは # 記号を使って示す.# 記号が現れた行は,それ以降がコメントになります.実行時にはコメントは無視されます.
# 平均を求める
avg = (1+2+3+4+5+6) / 6 # データの合計をデータ数で割る
print(avg) # 結果を出力する
3.5
なお,Windows で Jupyter Notebook / Jupyter Lab や Visual Studio Code を利用している場合は,ショートカットキー Ctrl + / で選択行をコメントアウトできるので覚えておくと良いでしょう.Mac の場合は ⌘ + / です.
また,複数行にわたるコメントを入力したい場合は,ダブルクォートを3つ重ねて """
で全体を囲います.シングルクォートでも構いません.囲われた範囲全体がコメントになります.しかしながら,3つのダブルクォートで囲った範囲はあくまでも文字列なので,#
によるコメントのように実行時に無視されるというわけではありません.このコメントの書き方は関数の説明 (docstring) を指定する時によく使用されます.
"""
複数行にわたるコメントを
入力することも
可能です
"""
print('コメントの書き方')
コメントの書き方