はじめてのPython入門
第5回 プログラムにコメントを入れよう

YouTubeでも動画に「コメント」が投稿できたりするよね

みなさん、こんにちは!

映画やアニメ作品の「オーディオコメンタリー」(出演者が作品へのコメントをしゃべってる動画)の楽しみかたが、未だにわからないあらたまです。

さて今日は「はじめてのPython入門」の第5回目です。

おさらい

前回の「第4回 命令への値の渡しかた」では 命令に値を渡す方法「引数(ひきすう)」について、お話をしましたね。

print("Hello World")

今回は「コメント」という機能についてお話したいと思います。

「コメント」ってなんだろう?

「コメント」は「Comment」という英単語なのですが、意外と日本語にはそれにぴったりと当てはまる単語がないのですよね。 あえて当てはめるなら「言い添える」でしょうか。

ちなみに辞書で「Comment」を検索すると、「批評」「解説」「注釈」などの意味が出てきます。

これらに共通するところは何かに対して言葉を横から足したり、付けたりすることですよね。

プログラミングにおける「コメント」

さて、そのような意味を持つ単語「コメント」ですが、プログラミングにおいても「コメント」をつけることができます。

プログラムに「解説」や「注釈」などの言葉を言い添える(書き添える)わけです。

あくまで解説や注釈ですので、プログラムの動作そのものには何の影響を与えません。

例えばこのような感じ

# 画面に文字を表示します
print("Hello World")

これを実行すると… コメントのあるプログラムを実行した例

「# 画面に文字を表示します」の部分が、動作に何も影響を与えていないことがわかりますね。

コメントの書き方

コメントの前に「#」を付けて書きます。

「#」がプログラム中に出てくると、そこからその行の終わりまでをコメントとみなします。

# 画面に文字を表示します
# 文字はHello Worldです
print("Hello World")

「#」より後ろがコメントになりますので、 命令の後ろにコメントをくっつけて書くということもできます。

print("Hello World") # 画面に文字を表示します

これらを実行すると… コメントのあるプログラムを実行した例2

やはりコメントが動作に何も影響を与えていないことがわかりますね。

プログラム中に文字列を書く方法

他にはプログラム中に文字列を書くことにより、 それをコメントのように使う方法もあります。

"こんな風に文字列を書いて、コメント的に使う"
print("Hello World")
"""あるいはこんな風に複数行の
文字列を書いて、コメント的に使う"""
print("Hello World")

ただし、これはあくまで「文字列をコメントのように使っている」だけで、 厳密にはコメントではありませんので、あまり使わない方が良いですね…

コメントは何のために書くの?

さてこの「コメント」。プログラムの動作に影響を与えないならいったい何のために使うの?って感じですよね。

使う理由はシンプル「人間がプログラムを見たときにわかりやすくするため」です。

例えばチームで開発して誰かにプログラムを見せる必要があるとき、 あるいは数か月後に自分でプログラムをアップデートするとき。

ひとの記憶なんて

ひとの記憶なんていいかげんなもので、数か月もたつと自分で書いたプログラムのことなんで8割がた忘れてしまってたりします。 (その間、まったく別のプログラムを書いてたりするので)

複雑なプログラムだったりすると、もう自分でも何が何やら。 それをチームで開発してる他の人に見せるとかなるとなおさらですよね。

もしも最初にプログラムを書いたときに、
「ここは〇〇だったので、△△を使うことにした」とか
「ここは○○の計算をしている」とか
コメントを書いていたとしたら、数か月後の自分にも、チームの他の人にもとても助けになるものです。

ですので、プログラミングをするときは日ごろからコメントは書く癖を付けておくのをお勧めしますよ。

今回はここまでです!

次回はプログラミングの必須知識、「変数(へんすう)」というものについてお話したいと思います。

次回へ続く。

>> 続きの記事
【はじめてのPython入門】第6回 ヘンスウってなんだ?