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

Pythonで複数行のコメントを書く方法をわかりやすく解説

Pythonにおけるコメントとは

コメントとは、プログラムのソースコード内に記述される、プログラマー向けの説明文や注釈のことです。コンパイラやインタプリタはコメントを無視するため、プログラムの動作には一切影響しません。

Pythonでは、シャープ記号(#)を行の先頭に付けることで、その行がコメントであることを示します。

複数行のコメントを書く基本の方法

実は、C言語のようなブロックコメント(/* ... */)はPythonには存在しません。そのため、複数行にわたってコメントを書きたい場合は、各行の先頭に#を付ける必要があります。

# コメント1
# コメント2
# コメント3
print("Hello World")

このように、コメントアウトしたい行すべてに#を記述すれば、何行でもまとめてコメントとして扱うことができます。エディタによっては、範囲を選択してショートカットキー一つで一括コメント化できる機能もあるので、活用すると便利です。

三重引用符を使った代替手段

もうひとつの方法として、三重引用符(''' または """)で囲まれた複数行文字列を利用する手法があります。関数やクラスのdocstring(ドキュメンテーション文字列)として使われていない場合、この文字列は実質的にコメントと同じように扱われます。

'''
コメント1
コメント2
コメント3
'''
print("Hello World")

ただしこの方法は厳密には「文字列オブジェクト」として評価されるため、正式なコメント構文ではありません。あくまで簡易的な代替手段と捉え、コードの説明には#を使うのがPythonのベストプラクティスといえます。

  1. PythonのBokehライブラリでステップ折れ線グラフを作成する方法

    BokehとはBokehは、Pythonでデータ可視化を行うためのオープンソースパッケージです。BokehはプロットをHTMLとJavaScriptを使って描画するため、Webベースのダッシュボードを構築する際に特に有用です。また、NumPyやPandasなど他のPythonパッケージと簡単に連携でき、インタラクティブなプロットやダッシュボードの作成にも活用できます。Bokehの依存パッケージnumpyPillowJinja2packagingPyYAMLsixTornadopython-dateutilBokehのインストール方法Windowsのコマンドプロンプトからインストールする場合は、

  2. Pythonで名前空間を作成する方法をわかりやすく解説

    Pythonでは、パッケージ、モジュール、クラス、関数、メソッドのそれぞれが独自の「名前空間(namespace)」を持っており、変数名はこの名前空間の中で解決されます。そして、関数やモジュール、パッケージが評価される(つまり実行が開始される)タイミングで、新しい名前空間が自動的に生成されます。そのため、名前空間を作成したい場合は、以下のいずれかの操作を行うだけで実現できます。関数を呼び出すオブジェクトをインスタンス化するモジュールをインポートするパッケージをインポートする例えば、「Namespace」というクラスを定義し、そのクラスのインスタンスを生成すれば、そのオブジェクト自体が一つの名前