ここから本文です

【Python入門】コメント

4/26(金) 11:30配信

@IT

 Pythonのプログラムには「コメント」を付け加えられる。コメントは、プログラムコードについて、後からそのコードを読む人のためにプログラマーがコード中に残すテキスト情報のこと。これについて、今回は見ていこう。

【画像:ブロックコメントとインラインコメント】

目次

・コメントとは
・ブロックコメントとインラインコメント
・コメントアウトによるプログラムコードの無効化
・Pythonファイルのエンコーディング宣言

コメントとは

 コメントとは「プログラムの内容について記述したテキスト」であり、プログラム中に書いておくことで、後から自分(あるいは別のプログラマー)がコードを読むときに参考となるものだ。Pythonではコメントは「#」記号で始まり、そこから行末までは全てコメントになる。コメントがプログラムとして実行されることはなく、Pythonプログラムの実行時には一切無視される。

 例として、第4回「変数とは」で見た、円の円周と面積を求めるコードにサンプルとしてのコメントを付けたものを以下に示す。なお、以下のコメントはあくまでも例であり、実際にコメントを記すときには「コードを見れば分かること」は書かずに、「そこでしていることの意味」「なぜこのコードを書いているのか」「注意点」など「後からコードを読み返すときに意味のあること」を記述するのがよい。

# ここから行末までは全てコメント
# r = 0
# 上の行はコメントなので変数rは定義されない
PI = 3.14 # 定数(このようにPythonのコードに続けてコメントを書いてもよい)
r = 1 # 変数rはここで定義される
print(2 * PI * r)
print(PI * r ** 2)
r = 2 # rの値を変更
print(2 * PI * r)
▲コメントの例

 上記のコードをセルに入力すると、次のようになる。

 コメント部分の色が変わり、それがコメントであることが一目で分かるようになっている。実行結果を以下に示す。コメントがプログラムの動作に影響を与えていないことが分かるはずだ。

 多くのエディタやIDE(統合開発環境)で、Pythonをサポートしているものでも、コメントが色を変えて表示される。例えば、以下はマイクロソフトが提供するテキストエディタである「Visual Studio Code」で新規Pythonファイル(.pyファイル)を作成して、上のコードを入力したところだ。

 文字列に含まれる文字「#」はコメントではないことには注意しよう。

# これはコメント
text = '# これはコメントではない'
print(text) # これはコメント
▲文字列に含まれる「#」はコメントの開始を意味しない

1/4ページ

最終更新:4/26(金) 11:30
@IT

こんな記事も読まれています

あなたにおすすめの記事