みなさん、コメントが好きですか？
プログラマーの間では、コメントの好き嫌いが結構ありますよね。
個人的には、好きではありません。
そのため、一人でプログラミングする際にはあまりコメントをしません。
しかし、複数人で仕事をするときにはコメントを残します。
やはり、第三者にはコメントがあった方がわかりやすいです。
ただ、それがミスリードを招く場合もあるのですよね。。。
コピペだとあるあるのミスになります。
今回は、そのようなコメントアウトに関する内容です。
Pythonでコメントアウトを複数行に行う方法ですね。
本記事の内容
- Pythonでコメントアウトを複数行に行う方法
- PyCharmで複数行にコメントアウトを行う方法
PyCharmにおけるTipsも載せておきます。
知っていると意外と便利です。
それでは、上記に沿って解説していきます。
Pythonでコメントアウトを複数行に行う方法
以下を見てください。
"""
Pythonで複数行にコメントアウトを行う1行目
Pythonで複数行にコメントアウトを行う2行目
Pythonで複数行にコメントアウトを行う3行目
"""
print("TEST")
「”」（ダブルコーテーション）3つで挟むだけです。
「”」の代わりに「’」（シングルコーテーション）3つでも構いません。
他のプログラミング言語を知っているなら、違和感を感じるかもしれません。
- PHP
- JavaScript
- Java
上記3つは、以下のようにコメントアウトを複数行に行います。
/* コメントの始まりと終わりを明示する形式に 慣れているので Pythonの形式は違和感がある */
Pythonを触り始めた当初は、なかなかこの違和感が消えませんでした。
でも、今ではもう単純に慣れましたけどね。
以上、Pythonでコメントアウトを複数行に行う方法を説明しました。
次は、PyCharmを使っている人にはおススメのノウハウを解説します。
PyCharmで複数行にコメントアウトを行う方法
PyCharmについては、次の記事で解説しています。
私は、AnacondaからPyCharmに乗り換えました。
「もっと早く乗り換えていれば」と思ったほどです。
そのPyCharmでの複数行コメントアウトの方法を説明します。
PyCharmでは、「Ctrl + /」でコメント「#」の切り替えが可能です。
この操作を利用すれば、複数行にコメントアウトが可能となります。
その操作を繰り返しているのが、次の動きです。
この処理を行えば、「”」3つでのコメントアウトをする必要はありません。
でも、複数人でのプロジェクトなら、そこはルールに従いましょう。
以上、PyCharmで複数行にコメントアウトを行う方法についての説明でした。
