Youtubeでも活動中

チャンネル登録してくれたら喜びます。
リンクフリー。共有・拡散は大歓迎!

このボタンで簡単にチャンネル登録!
PR

python~コメントアウトの方法~【pythonマスターへの道#003】

pythonでプログラミングをしていて、

実行したくない部分ってでてきますよね?

もしくは、各コード毎にどんなことをしているか

説明文(コメント文)を入れたいときってあると思います。

今回はそんなpythonのコメントアウトの方法をご紹介します。

この記事を読むことでわかること

自己紹介

サラリーマンしてます。

主に工場(生産現場)で使用する検査装置のアプリケーション開発してます。

ヒトの作業を自動化して簡略化するアプリケーションを日々開発中。

2022年5月に転職。現役バリバリの技術者です。
現在は超大手企業の新規事業分野で装置の研究・開発をしています。

Youtubeチャンネルにさまざまな動画を上げています

↓↓↓こちらからYoutubeチャンネルにアクセス!! ↓↓↓

注意

本ブログはアフィリエイトを用いた広告を掲載しています。

そもそもコメントアウトしたいときって…

それぞれコメントアウトしたい場面は人それぞれですが、

主にこの2つが頻度が高いですよね。

  • 実行しないけど、消すとまた書き直すのが手間だから残しておきたい。
  • 何をやっているのか、後から見返したときにわかるようにしておきたい
    いわゆるコメントをつけておきたい。

実行しないけど残しておきたい

これはデバッグをしていく中で複雑な分岐などしていくと、

そのうち必要になります。

他にも、1行で処理が完結している場合に、
その行をコピーしておいて、少し変えて実行するときなんかにも使えます。

もとに戻したければ、コピーしてコメントアウトしてあったところの、
コメントアウトを解除するだけで元通りですからね。

説明文としてコメントを付け加える

こちらもソースがどんどん複雑になってきた場合に

使用することになります。

もちろんソースコードを読めば何をやっているかはわかりますが、

日本語などでコメントしておくと何倍も思い出すのが楽になります。

複数のクラスをまたぐ複雑な場合など大変重要になります。

コメントアウトの種類

コメントアウトの種類は大きく分けて2つです。

  • #を使って1行コメントアウト
  • “””を使って複数行をコメントアウト

#を使って1行コメントアウト

説明文を書く時や、

1行だけ一時的に実行しないようにするときに使います。

このようにすると、実行されなくなります。

#これはコメント文です
print('test')
#print('test2')

testは出力されますが、

test2は出力されません。

それはこの#を頭につけているからです。
#が頭につくと、pythonではコメント行になると覚えておきましょう。

ちなみに、行丸ごとコメントアウトするだけでなく、
このように、処理の後ろにつけることも可能です。

#これはコメント文です
print('test') #ここにもコメントが入れられる。
#print('test2')

このほうが行が節約できるというメリットがあります。
ただし、コメントが長い場合は逆に見づらくなるので注意が必要です。

“””を使って複数行をコメントアウト

2行以上のコメントアウトが必要な場合、

#でももちろんできますが、

何回も#を文の頭に入れる必要があり、面倒ですよね?

2行以上のコメントアウトではこちらのように、

“””ではさんでコメントアウトしましょう。

#これはコメント文です
print('test')
"""
print('test2')
print(3+3)
"""
print(1+2)

#は単体で動作しましたが、

“””はコメントアウトしたい文たちを挟んでください。

こうすることで、

testと3のみが出力されます。

“””は挟んで初めて発動すると覚えておきましょう。

まとめ

今回はPythonのコメントアウト、説明文について

学習しました。

簡単な計算などではまだ必要性を感じられないと思いますが、

これから複雑になってくると作業性が全然変わります

また、他の人にソースコードを渡すときにも

説明文があるのと、ないのでは全く読みやすさが変わります!

是非マスターしてください!



コメント

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