Pythonにおける複数行コメントの記述方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonにおける複数行コメントの記述方法について現役エンジニアが解説しています。コメントはソースコード内のメモのように書けて実行時には無視(スキップ)される行のことです。Pythonでコメントアウトするには1行コメントには#(シャープ)を使い、複数行には"'を3つつなげて書きます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonにおける複数行コメントの記述方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

 

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonにおける複数行コメントの記述方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

コメント機能とは?

プログラムを書く際、どの言語においても処理内容や関数の説明を載せるときにソースコードにメモを残します。

この機能をコメント機能またはコメントアウトといいます。コメント機能を使うことでプログラムに影響することなくソースコード内にメモを残すことができます。
 

コメント機能の使い方

1行のコメント

1行でコメントアウトを行う際には#使って記述します。

# ここはコメント
print("ここは実行する")

 

複数行のコメント

今回の本題の複数行でのコメントです。複数行でコメントを残すときには、シングルクオーテーションまたはダブルクオテーション3つつなげたもので両端を囲んでコメントアウトします。

この手法はGithubで公開しているコードやドキュメント作成を行う際にはよく使用されます。また、ソースコードで実行したくない箇所が出てきた際には複数行に渡ってコメントアウトできます。

"""
ここはコメントです。
実行はされません。
"""
print("Hello World")

 

[PR] Pythonで挫折しない学習方法を動画で公開中

コメント機能を使って複数行のコメントをしてみよう

それでは、複数行のコメントをしてみましょう。

まずは以下のソースコードをコピーして任意の場所に保存しましょう。

def test(a):
    """引数
    a:数字(int)
    """
    return a + 1
print(test(2))

上記コードを実行すると、test関数に2を引数として渡した結果が帰ってくると思います。

関数内のコメントで引数の説明を入れているのが分かります。このようにして、関数の説明を行い引数を説明することで、引き継ぎで誰かにコードを渡す際に関数内の処理を知ることができてチーム開発の効率があがります。
 

まとめ

今回はPythonにおいてのコメント機能を紹介しました。

他人に自分のソースコードを読んでもらうためにコメントはとても大切です。ただし、あまり使いすぎるとかえって読みづらくなるので、適度に使うようにしましょう。
 

監修してくれたメンター

メンター三浦

モバイルゲームを運用している会社のエンジニアをしています。趣味でWEB開発やクラウドコンピューティングもやっており、ソフトもハードもなんでもやります。

TechAcademyジュニアではPythonロボティクスコースを担当しています。好きな言語はPython, Node.js。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。