Python|コメントアウトの書き方

1. はじめに(導入文)

Pythonの学習を始めたばかりの方がまず覚えるべき基本のひとつが「コメントアウトの書き方」です。
コメントはコードの可読性を高めたり、メモを残したりするために欠かせない機能です。
この記事では、Python|コメントアウトの書き方というテーマで、基本的な記述方法から、実務で役立つ使い方までを詳しく解説します。

初心者にもわかりやすい具体例を交えながら、コメントの基本と注意点を押さえていきましょう。

 

2. Pythonにおけるコメントアウトの基本

2-1. コメントとは?

コメントとは、コードの中に書くメモのようなものです。Pythonでは、#(シャープ記号)を使って1行コメントを書くことができます。コメントは実行時に無視されるため、プログラムの動作には影響しません。

2-2. 1行コメントの書き方

# これはコメントです
print("Hello, world!")  # ここでもコメントを書けます

実行結果:

Hello, world!

2-3. 複数行のコメントの書き方

Pythonには公式な「複数行コメント」の構文はありませんが、複数の#を使えば擬似的に書くことができます。また、'''(三重引用符)"""(三重ダブルクォート)を使ってコメントとして利用するケースもあります。

# これは1行目のコメント
# これは2行目のコメント
# これは3行目のコメント

'''
この部分もコメントとして扱われますが、
厳密には文字列扱いです。
通常はドキュメンテーション用に使用されます。
'''

注意: 三重引用符を使う方法は、Python的には「文字列」として認識されます。そのため、関数やクラスの先頭に書くとドキュメンテーション(docstring)として扱われます。

 

3. コメントのよくある使い方・応用例

3-1. 一時的にコードを無効化するとき

デバッグや動作確認中、一部のコードを一時的に無効にしたいときにコメントアウトは非常に便利です。

# print("この行はコメントアウトされているため、実行されません")
print("この行だけ実行されます")

実行結果:

この行だけ実行されます

3-2. コードに説明を加える(ドキュメントとして活用)

チーム開発や将来の自分のために、処理の目的やロジックをコメントで説明しておくのはとても重要です。

# 商品の価格と数量を掛けて合計金額を計算する
price = 100
quantity = 3
total = price * quantity  # 合計金額を算出
print(total)

実行結果:

300

3-3. ドキュメンテーション文字列(docstring)の活用

関数の説明を記述するには、コメントよりもdocstringが適しています。

def greet(name):
    """与えられた名前に対して挨拶を返す関数"""
    return f"こんにちは、{name}さん!"

print(greet("佐藤"))

実行結果:

こんにちは、佐藤さん!

&nbsp

4. コメントアウトに関する注意点・エラー対策

4-1. コメントを多用しすぎない

コメントが多すぎると、かえって可読性が下がることがあります。変数名や関数名を工夫することで、コメントが不要になるケースもあります。

4-2. コメントの内容が古くなる

コードを修正したのにコメントが更新されていないと、誤解を招く恐れがあります。コメントもコードの一部と考え、常に最新に保ちましょう。

4-3. インデントとコメントの位置に注意

コメントの位置によっては、Pythonが構文エラーとして認識することもあります。以下のような間違いに注意しましょう。

# 正しい例
if True:
    # このブロックの中でコメント
    print("OK")

# 間違い例(コメントが不適切な位置にあるとエラーに)
# if True:
# print("NG")  # インデントが合っていない

&nbsp

5. まとめ

本記事では「Python|コメントアウトの書き方」について、基本から応用までを解説しました。コメントはコードの品質を高める重要なツールです。以下のポイントを押さえておきましょう。

  • #を使って1行コメントを書く
  • 三重引用符('''""")は説明文(docstring)にも使える
  • 一時的なコードの無効化や処理説明に便利
  • コメントもメンテナンスが必要

実務では、他人や未来の自分が見てもすぐ理解できるようなコメントを意識することが大切です。
学習のコツとしては、「コメントを書きながらコードを読む」習慣をつけると理解が深まります。

ぜひこの記事を参考に、実務や学習の現場でコメントを効果的に活用してみてください!

タイトルとURLをコピーしました