Python
 Computer >> コンピューター >  >> プログラミング >> Python

Pythonでコメントを書く方法を徹底解説!基本の書き方と複数行コメントのコツ

Pythonにおけるコメントとは?

コメントとは、コンピュータプログラムのソースコード内に記述される、プログラマ向けの説明文や注釈のことです。コメントはコードの意図や処理内容を人間が理解しやすくするために書かれるものであり、コンパイラやインタプリタによって完全に無視されるため、プログラムの実行結果には一切影響しません。

Pythonでのコメントの基本的な書き方

Pythonスクリプトでは、#(シャープ)記号がコメント行の開始を表します。この記号以降から行末までがコメントとして扱われます。

  • # が行の最初の文字であれば、その行全体がコメントになります。
  • # は行の途中でも使用できます。その場合、# より前の部分は有効なPythonの式として実行され、# 以降のテキストのみがコメントとして無視されます。

以下に具体的な例を示します。

#これはコメントです
print("Hello World")
print("Welcome to TutorialsPoint")  #これもコメントですが、ステートメントの後に記述しています。

Pythonに複数行コメント(ブロックコメント)はない

Pythonには、C言語やJavaのような「/* ~ */」形式の複数行コメント(ブロックコメント)を記述する仕組みが標準では用意されていません。そのため、複数行にわたってコメントを書きたい場合は、各行の先頭に # を付ける必要があります。

ただし、多くのPython対応IDE(PyCharm、VS Codeなど)には、選択した範囲のステートメントを一括でコメント化・コメント解除できるショートカットキーが用意されているため、効率的に作業できます。

三重引用符を使った擬似的な複数行コメント

もうひとつのテクニックとして、三重引用符(''' または """)で囲まれた複数行文字列も利用できます。この文字列が関数やクラスのdocstring(ドキュメンテーション文字列)として割り当てられていない場合、実行時には評価されず、事実上コメントのように扱うことができます。

'''
comment1
comment2
comment3
'''
print("Hello World")

なお、関数・クラス・モジュールの直下に記述された三重引用符の文字列はdocstringとして認識され、help()関数などで参照可能になる点には注意しましょう。

まとめ

  • Pythonのコメントは # 記号で始まり、行末までが有効。
  • 行の途中にも記述でき、# 以降のみがコメント扱いになる。
  • 標準の複数行コメント機能はないため、各行に # を付けるかIDEのショートカットを活用する。
  • docstringでない三重引用符の文字列は、擬似的な複数行コメントとして使える。
  1. Instagramのコメント管理を完全ガイド!投稿・DM・ストーリーズの使い方まとめ

    Instagramは世界で最も人気のあるSNSの一つです。写真や動画を手軽に共有できるシンプルな設計が、急速な普及の原動力となりました。そして、その体験に欠かせないのが「コメント」機能です。本記事では、Instagramのコメントに関するあらゆる操作方法——書き込み方から削除、非表示、制限設定まで——をスマートフォンとPCの両方の視点から詳しく解説します。 投稿へのコメント コメントは、Instagramにおける最も古くからある交流手段です。モバイルアプリでもPCでも操作方法はほぼ共通しています。ここでは、投稿へのコメントに関する基本をまとめました。 1. Instagramの投稿にコメント

  2. Wordでコメントを追加・削除する方法|返信や解決の操作もわかりやすく解説

    文書を相手と同じ場所で一緒に確認できないとき、次善の策となるのがコメント機能です。Microsoft Wordでは、テキストを選択してコメントを挿入するだけで簡単にフィードバックを残せますし、既存のコメントに返信して意見を交わすこともできます。 グループプロジェクトでの共同作業、友人の小説のプロットへの感想、あるいは自分自身の原稿の編集など、コメント機能はあらゆる場面で役立つ強力なツールです。この記事では、Wordでコメントを追加・削除する方法を詳しく解説します。 注: 本記事のスクリーンショットはmacOS版のMicrosoft Wordを使用していますが、Windows版でも手順は同じ