1ヶ月でWebデザイン・プログラミングスキルをオーダーメイドのカリキュラムで学べるスクール、それがWebCamp。

子供の想像力を伸ばしアイデアを形にする小学生向けプログラミング教室「プロスタキッズ」

Python超入門その12〜コメントを書いてコードを説明しよう〜

Pocket

はじめに

長いプログラムが書けるようになってきましたか?

プログラムが長くなってくると、だんだんと理解しづらくなってきます。必然的にコード量が増えるので、これはある意味仕方のないことです。
また、数週間前に書いたコードは、自分でも内容を忘れてしまっていることもあります。できるだけコードをわかりやすくするためになにができるでしょうか?そのひとつがソースコードに記述する「コメント」です。

この記事では、Python初心者の方向けに、Pythonでのコメントの書き方について説明していきます。しっかりコメントを書いて、わかりやすいコードにしていきましょう。

コメントの記述方法

Pythonでコメントを記述するには、先頭に「#」をつけます。たとえば、次のような形です。

例:

 

これは単一行コメントと呼ばれるもので、”#”から行末までがコメントとして扱われます。コメントはプログラムとしては扱われないため、特殊なコメントを除き、基本的になにを書いてもプログラムに影響を与えません。

C系の構文を持つ言語とは異なり、Pythonには複数行コメントがありません。そのため、複数行のコメントを書く場合には、単一行コメントを複数行書く必要があります。または、次のように複数行文字列を使って、擬似的に複数行コメントを記述します。

例:

 

例ではダブルクオーテーション(”)を使っていますが、シングルクォーテーション(’)でもOKです。ただし、単一行コメントとは違い、インデント(字下げ)を合わせる必要があることに注意しましょう。

コメントにはなにを書けばいいの?

コメントでは、プログラムが行っていることを端的に説明しましょう。もちろん、すべての行にコメントを書く必要はありません。自分でプログラムを読んでみて、わかりにくいと思うところや忘れると後で困りそうなことをコメントに残しておきましょう。

とはいえ、なんでもかんでもコメントにすればいいわけではありません。次項で悪いコメントの例をみていきましょう。

悪いコメントの例

*当たり前のことが書いてある 初心者の方にありがちなのが、コードを読めばすぐわかるようなことをコメントに書いてしまうことです。たとえば、次のようなコメントです。

例:

 

例のように、コードを読めばすぐにわかるようなことをコメントにする必要はありません。もし記述するのであれば、”動作”を書くのではなく、”理由”を記載しましょう。たとえば、次のように書きます。

例:

 

このように、コメントにはコード以上の情報をもたせるようにしましょう。

*コードと整合性が取れていない プログラムは、運用期間中に何度も修正されます。そのため、コードとコメントの整合性がとれなくなっていることもしばしばあります。たとえば、次のような例です。

例:

 

例のように、消費税程度であればどちらが正しいのかは明白ですが、実際にコメントが必要とされるような複雑なケースでは、どちらが正しいのかわからずに混乱を招くことも少なくありません。コードを修正したら、関連するコメントもしっかり直しましょう。

コメントアウトを活用しよう

コメントはコードを説明するだけでなく、一時的にコードの一部を無効化(コメントアウト)するためにも使われます。再び使用するときはコメントアウトを解除(#を削除する)だけなので、手軽に使えます。

ただし、プログラムに不要なコードをいつまでも残さないようにしましょう。不要なコードを放置すると、いつまでも削除されずに、ソースコードがゴミだらけになってします。あくまで一時的な使用にとどめておきましょう。

まとめ

コメントの書き方がお分かりになりましたか?
Pythonには、基本的に単一行のコメントしかないことに注意しましょう。複数行コメントの代替方法もありますが、インデントに注意が必要です。また、コメントに書く内容には注意しましょう。意味のないコメントはあっても邪魔なだけです。できるだけコード自身で説明するように心がけて下さい。コメントアウトによる、一時的なプログラム修正も活用しましょう。

投稿者:プロスタ編集部

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

初心者がプログラミングで挫折しない学習方法を無料動画で公開中。オンラインに特化したプログラミングスクール「TechAcademy(テックアカデミー)」が解説。

この記事が気に入ったら
いいね!しよう

プロスタの最新情報をお届けします

あわせて読みたい

関連記事

ページ上部へ戻る