【脱・コード迷子】「3日後の自分」を救う!Pythonコメントアウトの実践ガイド【コピペOK】

【作業自動化】Python
スポンサーリンク

今回はコードの可読性と保守性を高める「コメントアウト(コメント機能)」の基本と実践テクニックについて解説します。

【作業自動化】Pythonの記事を見る 

コメントアウトとは?

一言で言うと、「プログラムの実行時には無視されるけど、人間には読めるメモ」のことです。

Pythonはコードに書かれた文字を上から順に実行しますが、特定の記号をつけることで「この部分は実行対象外」とコンピュータ(インタプリタ)へ指示することができます。

書き方はとってもシンプル。たった2つのルールを覚えるだけでOKです。

すぐ使える!基本の書き方【コピペOK】

記述方法には、一番よく使う「1行コメント」と、詳細な説明を残すための「複数行コメント」があります。

① 1行コメント(#を使う)
シャープ(ハッシュ)記号を書くと、そこから行末までがコメントになります。

# これはコメントです。プログラムには影響しません。
print("こんにちは!")  # コードの横に書くこともできます

② 複数行コメント(””” または ”’ を使う)
クォーテーションを3つ続けると、その間の行はすべて文字列扱い(実質コメント)になります。長い説明を書きたい時に便利です。

"""
ここもコメントとして扱われます。
改行を挟んで複数行の記述が可能です。
3日後の自分のために、意図を丁寧にメモとして残しましょう。
"""
print("複数行のコメントの例でした")


なぜコメントを書くのか?「3日後の自分」は他人です

「今はわかってるから書かなくていいや」

そう思ってコードを書くと、3日後(あるいは3分後)に後悔します。

  • 「あれ? この変数 x って何の数字だっけ…?」
  • 「なんでここで +1 してるんだっけ…?」

人間は忘れる生き物です。特に慣れないコードを書いているときは、頭がパニックになりがちです。

だからこそ、コメントは「未来の自分へ宛てた引き継ぎメモ」として残しておくことが大切になります。

業務における「引き継ぎマニュアル」を作る感覚に近いかもしれませんね。「背景を知らない第三者が見ても意図が明確に伝わる状態」を意識することが作成のコツです。

実践的なコメントの書き方(良い例・悪い例)

コメント作成における重要な鉄則は、「コードを見ればわかること」は書かないことです。

× 改善が必要な例(コードを見れば分かる内容)

price = 1000
# 価格に1.1を掛ける
tax_price = price * 1.1

○ 望ましい例(背景や意図を明記)

price = 1000
# 標準税率(10%)を加算して税込合計金額を算出
tax_price = price * 1.1

「何をしているか(What)」ではなく、「なぜそうしているか(Why)」を書くことで、後からコードを見返した際の理解スピードが格段に上がります。

コードの一時的な「無効化」としての活用法

コメント機能は、メモを残すだけでなく「コードの一時退避」としても非常に役立ちます。

「この処理を削除するとエラーが出るかもしれない」と不安な場合は、削除せずに該当箇所をコメントアウトして無効化します。

# print("動作に問題がある可能性があるため、一時的に無効化")
print("正常に稼働しているコード")

この方法を用いれば、必要に応じていつでも元のコード状態へと復元できます。

VS Codeなどの主要エディタでは、該当行を選択して「Ctrl + /」(Macは「Cmd + /」)を押すだけで一瞬で切り替えが可能です。

おわりに

コメントアウトは、プログラミングにおける「人のための安全装置」です。

コードを書く際は「ここは重要な分岐点」「ここは一時的な暫定対応」といった開発時の意図をメモに残すことから始めてみてください。丁寧なコメントは、必ず将来の開発を助けてくれます!

【作業自動化】Pythonの記事を見る 


Pythonの本は種類が多すぎて、業務効率化に使えるのか見分けるのが大変ですよね。実務自動化に5年以上携わってきた私が、「デスクワークの自動化に即戦力になった本」を厳選して紹介します。失敗しない1冊を見つけたい方は、ぜひ参考にしてみてください。

この記事を書いた人
ぐー

手取り15万円の会社員でしたが、年間100万円以上節約していました。
株式投資で年間360万円以上投資し、iDeCoも併用しています。
総資産はアッパーマス層に到達しました。
資格は日商簿記3級を持っています。

このブログでは、私が実践してきた節約術やリアルな資産運用、生産性を高めるITスキルについて発信しています。

生活を豊かにするため、高配当株投資で年間配当金60万円をめざしています。
現在の年間配当金は30万円ほどです。

ゲーム・漫画・アニメなどが好きです。
一緒に資産形成をがんばりましょう!
よろしくお願いします!

ぐーをフォローする
【作業自動化】PythonITスキル
スポンサーリンク
ぐーをフォローする

コメント

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