Pythonを書くときに意外と重要なのが「コメント」です。コメントはコードの動作には影響しませんが、可読性を高めたり、チーム開発を円滑にしたりする効果があります。この記事では、Pythonのコメントの基本から応用的な使い方、さらに注意点までわかりやすく解説します。
Pythonにおけるコメントとは？
まず、コメントとはプログラムにメモを残すための仕組みです。Pythonでは # を使うと、その行の右側すべてがコメントになります。コメントは実行時に無視されるため、コードの動作には影響しません。しかし、後で見返したときや他の人に見てもらうときに役立ちます。
# これはコメントです
print("Hello") # ここもコメント
このように、1行をまるごとコメントにする方法と、コードの後ろに書く方法があります。どちらもよく使われるので覚えておくと便利です。
コメントを書くメリット
なぜコメントを書く必要があるのでしょうか。理由は大きく分けて3つあります。第一に、コードの意図を記録できることです。数か月後に自分が見返したときでも、何を考えて書いたのかがすぐにわかります。第二に、他の人が読むときの助けになることです。特にチーム開発では「なぜこの処理が必要なのか」を説明するコメントが重宝されます。そして第三に、バグ修正や機能追加のときにコードを理解しやすくなることです。
単一行コメントの書き方
Pythonで最もよく使われるのが単一行コメントです。先頭に # を付けるだけで、その行はコメントになります。
# ユーザーの名前を出力する
print("Taro")
シンプルですがとても便利です。コードが短い場合でも、処理の意図を短く書いておくと、後で見返すときに理解が速くなります。
書きすぎに注意
ただし、すべての行にコメントを書く必要はありません。明らかに分かる処理に冗長なコメントを付けると逆に読みづらくなります。適度なバランスを心がけましょう。
複数行コメントを使う方法
ときには複数行にわたって説明をしたいことがあります。Pythonには専用の「複数行コメント」という仕組みはありませんが、慣例的に # を複数行に並べて書くことで対応します。
# 以下の処理はユーザー情報をまとめて出力する
# 名前、年齢、住所を順番に表示する
print("Taro")
print(25)
print("Tokyo")
また、文字列を利用した疑似的な方法もあります。これは公式ドキュメントでも使われることがあります。
"""
このプログラムは
ユーザー情報を表示します
"""
print("Hello")
ただし、この方法は実際には文字列として扱われるため、本来は「ドキュメンテーション文字列（docstring）」に使われます。単純なコメントには # を使うのが一般的です。
docstringとコメントの違い
初心者がよく混同するのが「コメント」と「docstring」の違いです。docstringは関数やクラスの説明を書くための仕組みで、三重クォーテーションで囲んで記述します。例えば以下のように使います。
def greet(name):
"""名前を受け取り、挨拶を返す関数"""
return f"Hello, {name}"
docstringは help() 関数などで参照できるため、単なるメモではなく「公式な説明文」として活用されます。コメントとは用途が異なるので覚えておきましょう。
コメントを書くときのベストプラクティス
コメントを有効に活用するには、いくつかのポイントがあります。まず、処理の「目的」を書くことが大切です。単に「変数を初期化」など動作を説明するのではなく、「なぜそうするのか」を書くと有益です。また、英語で統一するプロジェクトもありますが、個人学習では日本語でも問題ありません。さらに、定期的にコメントを見直し、コードの変更に合わせて修正することも必要です。
良い例と悪い例
# 悪い例
i = 0 # iに0を代入
# 良い例
i = 0 # ループ回数をカウントするための初期化
このように、意味のないコメントではなく、意図が伝わるコメントを書きましょう。
よくあるエラーや注意点
コメント自体は実行に影響しませんが、いくつか注意点があります。例えば、文字コードの宣言をコメントで書く場合があります。Python 3では基本的にUTF-8がデフォルトですが、古い環境では以下のように記述する必要がありました。
# -*- coding: utf-8 -*-
また、コメント内に全角スペースや特殊文字を多用すると、環境によっては文字化けすることがあります。特にチーム開発では統一したルールを守ると安心です。
応用テクニック：コメントアウトで一時的にコードを無効化
開発中によく使われるのが「コメントアウト」です。コードの一部を実行しないようにすることで、動作確認やデバッグに役立ちます。
# print("この行は実行されません")
print("この行だけ実行されます")
さらに、複数行を一度にコメントアウトしたいときはエディタのショートカットを活用すると効率的です。例えばVSCodeなら Ctrl + / で選択行をまとめてコメントできます。
Python初心者におすすめのサービス
「もっと実践的なコード例が欲しい」「自分の用途に合わせて教えてほしい」という方には、
テックアカデミーがおすすめです。
AI関連コースやシステム開発コース、アプリ開発コースなど豊富な学習が可能です。
さらに今なら無料相談でアマギフプレゼントもあるので、気軽にお申込みしてみてください。
また、プログラミング学習のプラットフォームとして、ココナラでは、現役エンジニアや経験豊富なPython講師が、あなたのレベルや目的に合わせてマンツーマンで指導してくれます。
書籍や動画ではカバーしきれない、あなた専用のカリキュラムで学べるのが最大の魅力。短時間で効率的にスキルを伸ばしたいなら、まずは出品者のサービスをチェックしてみましょう。
また、教える側としてスキルを活かして副業・独立を目指すことも可能です。
プログラミング経験やPythonの知識があれば、自分の得意分野をサービスとして出品し、全国の学習者から直接依頼を受けられます。オンラインで完結するため、場所や時間に縛られず、自分のペースで働けるのも大きなメリットです。
こちらのリンクから詳細をチェックしてみてください。
まとめ
Pythonのコメントは、コードを理解しやすくするための強力なツールです。単一行コメントやdocstringを使い分け、適切な場所に残すことで、学習や開発をスムーズに進められます。意図を説明するコメントを意識的に書いてみましょう。
参考：Python公式ドキュメント：ドキュメンテーション文字列
さらに理解を深めたい方は、Pythonのlistの使い方を学ぶと、配列処理に役立ちます。またfor文やwhile文の基礎も合わせて読むと理解が一気に広がります。
コメント