プログラミングのすすめ

プログラミングに関する情報サイト

【Python】入門者必見!コメントでコードを見やすくしよう

今回はPythonでのコメントの書き方を見ていきます。 初心者の方でもわかりやすいように、

  • そもそもコメントって何?
  • コメントの書き方ってあるの?
  • 複数行にコメントを書く場合はどうするの?

この3つの内容について解説していきます!

Pythonのコメントとは?

まずは、そもそも「コメント」とはなんなのか。についてみていきましょう。 Pythonプロジェクトでは自分が書いているコードについて目的や説明を、コードを見た第三者の人に正しく伝える必要があります。 なぜかというと、「他人のコードを説明無しで解読するのはとても難しい」からなんです。

 
いくらPython自体がコーディングルールがあって「誰でも同じコードになる」と言われていても、コメントの有無では解読性が全然違うんです!

また、Pythonのコメントはコードの説明だけではなく、実行させたくないコードを無効化したいという時にも使用します。 このコメントとしてコードを無効化することを”コメントアウト"と呼びます。

Pythonでのコメントの書き方

ではさっそくPythonでコメントを書いてみましょう。 コメントには1行をコメントにするやり方と2行以上の複数行をコメントにする2つの方法があります。

基本的な書き方

まずは基本的な書き方である、コメントの定義の仕方を見ていきましょう。 Pythonでコードにコメントを挿入する時は、「#」(シャープ)を使います。 ”#”以降に書く文章は、その行の終わりまでコメントとして無視されることになります。  

1行のコメントを書きたい場合

実際にサンプルコードでどう書くのか見ていきましょう。

# "Hello world"と出力されます。
print("Hello world!")

このように”#”を使って同じ行に文字を書くとコメントとみなされ、実行してもこのコメントアウトされた行は表示されません。

複数行のコメントを書きたい場合

「#」を使って複数行をコメントアウトするには、行ごとに毎回「#」を付けるという方法もあります。 ですが、この場合多くの行をコメントアウトするのには、当然向いていませんし正直めんどうですよね。 じゃあどうするかというと、「’」(シングルクォーテーション)または「”」(ダブルクォーテーション)を3つ書いてコメントアウトする部分を囲みましょう。

print("Hello world!")
'''
print("Hello world!!")
print("Hello world!!!")
print("Hello world!!!!")
'''

このようにコードを書いたとします。 これを実行すると、1行目のprint("Hello world!")は実行されますが、それ以外の2行目以降のコードは「'」シングルクォーテーション3つで囲んでいるので、実行されません。

まとめ

Pythonだけでなく様々なプログラミング言語のほとんどにある「コメント」という機能について解説しました。 実行結果には反映されないので、なくてもいいのでは?と思うかもしれませんが、プログラムというのは1度作ったら終わりではなく、運用していく中で不具合の修正や新しい機能の追加などが必ずあると思います。 ずっと作っている人が同じならいいですが、そうではない場合がほとんどです。 そんな時に、ほかの人が書いたコードは「何をしているのかがパッと見てわからない。」となってしまいそれを調べる時間が発生したりと、無駄が増えてしまいます。

  • 何の処理をしているのか。
  • どのような意図があるのか。
  • 今後注意が必要な個所の説明

などがコードの中にコメントがあることで一目でわかります。 そのように見やすいコードを書くことは、コーディングする人にとって、必須スキルともいえるほど大事なことなので、コメントを使って見やすいコード作りを心がけてください。


PVアクセスランキング にほんブログ村