コメントをソース上に書いておくことで、後から見返したときにソースが読みやすくなるメリットがあります。
プログラムは一度開発して終わりではなく、その後何度も改良していく必要があるため、ソースを読みやすくしておくことは重要です。
本記事ではPythonでコメントアウトを行う方法について解説します。
また、コメントアウトを行う際に心がけたいことについてもまとめました。
コメントアウトはどんなときに行う？
コメントアウトを行うときは次の3つに該当するときです。
- ソースの意味が伝わりにくいとき
- リリース後のソースを修正したとき
- 特定箇所を削除してテストしたいとき
どんなときに書くかによって、コメントの書き方が全く異なるため、3つのパターンの違いを理解しておくことが重要です。
1）ソースの意味が伝わりにくいとき
ソースコードを見るだけでは何の処理を行っているのか分かりにくいとき、コメントで補足を行うときがあります。
たとえば、if文やwhile文がネストされていて処理内容を追いにくい場合、などです。
コメントを書くことで他の人が安心して修正対応を行えるようになるでしょう。
2）リリース後のソースを修正したとき
システムをリリースした後にバグが発覚するなどして、1、2行だけソースコードを変更しないといけない場合があります。
リリース後に修正する場合は、「誰が」「いつ」「なぜ」修正したのかコメントに残しておくと良いです。
後で不具合が見つかった際に修正した部分が原因かどうかを特定しやすくするためです。
3）特定箇所を削除してテストしたいとき
ソースコードの一部をコメントアウトすることで、その部分を除外してテストを行うことが可能です。
たとえば、ソースコードの10行目までだけを抜き出してテストしたい場合、11行目移行をすべてコメントアウトしてしまうことで10行目までのデバッグが可能になります。
スピーディーにテストを行いたい場合に便利な方法なので、覚えておきましょう。
Pythonのコメントアウトの書き方
Pythonのコメントアウトの書き方について解説します。
コメントを書く場合、次の2つの方法があります。
- 一行のコメントを書く
- 複数行のコメントを書く
1つ1つの方法について詳しく解説していきます。
1）一行のコメントを書く
ソースコード上で下記のように普通にコメントを書くと、エラーが出力されてしまいます。
○コード例
文字列を表示
print("Hello World")○実行結果
これは、コンピュータ側が「どこまでがプログラムのコードでどこまでがコメントなのか」をちゃんと認識できないためです。
コメントをソースコードに残す場合は、「これはコメントです」としっかりコンピュータ側に示す必要があります。
そして「これはコメントです」と示す際に使うのが「#」という記号です。
「#」を頭につけて記載することで、コメントを残すことができます。
○コード例
# 文字列を表示
print("Hello World") ○実行結果
上記のように「#」をつけることによってエラーが出力されなくなります。
また、コメントは下記のようにコードの横にも記述することが可能です。
○コード例
print("Hello World") # 文字列を表示○実行結果
2）複数行のコメントを書く
続いて、複数行のコメントを書く方法を解説します。
複数行のコメントを書く場合「”’」でコメントを括る方法があります。
○コード例
'''
文字列を表示する
文末に改行は入れない
'''
print("Hello World", end="") ○実行結果
上記のように複数行の文章を「”’」で括ることでコメントアウトが成功します。
こちらもよく使うやり方なので覚えておきましょう。
コメントを書く際に心がけたいこと
最後に、コメントを書く際に心がけたいことについてまとめました。
Pythonでコメントを書く場合は次の4つに気をつけると良いでしょう。
- インデントは正しく整える
- コメントの書きすぎはNG
- なぜそう書いたのか理由を書く
- コメントのルールを決めておく
1）インデントは正しく整える
先程解説したように「”’」で括ることで複数行のコメントを書くことが可能です。
しかし、Pythonではコメントを行う際もインデントを正しく整える必要があります。
コメントも正しくインデントされていないとエラーが発生してしまいます。
2）コメントの書きすぎはNG
確かにコメントを書くことで、ソースコードの可読性が高まることもあります。
一方でコメントを書きすぎるのは良くない場合もあります。
コメントを書きすぎると単純にコード量が増えてしまい、全体の処理内容を追いにくくなってしまいます。
処理内容が分かりにくい部分のみコメントを残すことが重要です。
3）なぜそう書いたのか理由を書く
コメントアウトを行う際は、なぜそのようなソースコードを書いたのか、理由を記載しておく必要がある場合もあります。
先程解説した通り、コメントを書くのは処理が分かりにくい場合のときです。
コメントで補足する書くよりも、できることなら処理内容を分かりやすく書いたほうが良いです。
つまり、コメントを書く場合は「そう書かざるを得ない」場合が多いということです。
そのため、「なんでわざわざそんな処理を行っているのか」理由を書いておくことで、他のプログラマーの疑問を解決することができます。
4）コメントのルールを決めておく
特にチームで開発を行う場合は、コメントの記載ルールを設けておくと良いでしょう。
たとえば、「変更日時を必ず記載する」「コメントが何行にも渡るようならtxtファイルにまとめてリンクを掲載する」などです。
コメントアウトに限った話ではありませんが、記述ルールをある程度設けておくことで、プログラマー間での意思疎通がしやすくなるメリットがあります。
【補足】エディタによってはショートカットキーでコメントが書ける
エディタによって仕様が変わってしまうのですが、場合によってはショートカットキーでコメントを書ける場合があるので補足します。
たとえば、Visual Studio Codeの場合、「Shift＋Alt＋A」を押すことで指定箇所を「”’」で括りコメントとすることが可能です。
さらに「Ctrl＋／」を押すことで指定箇所を「#」で始まるコメントに変更することが可能です。
また、Jupyter NotebookやPyCharmといったエディタでも「Ctrl＋／」を押すことで指定箇所をコメントに変更することができます。
メモ帳などのエディタだとショートカットキーが実装されていない場合も多いのですが、もし使えるならコメントアウトを利用してのデバッグの効率を高めることが可能です。
まとめ
本記事ではPythonでコメントアウトを行う方法について解説しました。
コメントアウトを正しく行うことで、ソースの可読性向上に繋がり、運用・保守がしやすくなります。
Pythonを学習中の方はコメントの書き方についても勉強しておきましょう。