Pythonで複数行をコメントアウトする方法
目次
コメントアウトとは？
コメントアウトとは、プログラムの一部分を実行時に無視させるための手法です。この技術は、コードの一時的な無効化や、他の開発者への説明追加などに用いられます。
コメントアウトされたコードはプログラムの実行に影響を与えず、文書化の一環として、または将来的な使用のためにコードを保持しておくための便利な方法として活用されます。適切にコメントアウトを使用することで、コードの可読性と保守性が向上します。
1. ハッシュ記号を使った複数行コメントアウト
1つ目は、ハッシュ記号（#）を使った方法です。
各行頭に#記号を記述することで、その行をコメントアウトできます。
| # これは1行目のコメントです。 print("Hello, world!") # これは3行目のコメントです。 |
メリット
- トリプルクォートよりも軽量
- インデントの影響を受けない
デメリット
- ネストしたコメントが記述できない
2. シングルクォートまたはダブルクォートを3つ繋げた複数行コメントアウト
Pythonで複数行をコメントアウトするには、いくつかの方法があります。
2つ目は、シングルクォーテーションまたはダブルクォーテーションを3つ繋げた方法です。
シングルクォートまたはダブルクォートを3つ連続で記述することで、複数行をコメントアウトできます。
| """ これは複数行のコメントです。 この部分もコメントです。 """ print("Hello, world!") |
メリット
- 他の方法に比べてシンプルでわかりやすい
- ネストしたコメントも記述可能
デメリット
- インデントが崩れる可能性がある
3. コメントアウト用のプラグインを使った複数行コメントアウト
3つ目は、コメントアウト用のプラグインを使った方法です。
PyCharmなどのIDEでは、コメントアウト用のプラグインが提供されています。
PyCharmの場合、Ctrl + /キーを押すと、選択範囲がコメントアウトされます。
※こちらの方法は、実際にはコードブロックを文字列として扱い、Pythonインタプリタによって無視される効果を利用しているため厳密には「コメントアウト」とは異なりますのでご注意ください。
| # これは1行目のコメントです。 print("Hello, world!") # これは3行目のコメントです。 |
メリット
- ショートカットキーで簡単にコメントアウトできる
- コードの見た目もスッキリする
デメリット
- プラグインのインストールが必要
まとめ
Pythonで複数行をコメントアウトするには、いくつかの方法があります。それぞれの特徴を理解して、状況に応じて使い分けることが重要です。
最初はトリプルクォートを使う方法がおすすめです。シンプルでわかりやすく、ネストしたコメントも記述できますので是非使ってみてください。