Pythonでのコメントアウトのルールや複数行、範囲指定について解説する

本記事では、Pythonのコメントアウトについて解説していきます。

Pythonでコメントを書く方法

まずは概略から。

• Pythonのコメントは#文字で始まり、行末まで伸びます。
• 行の先頭から、いくつかの空白やコードの後にコメントを開始することができます。

• ハッシュ文字が文字列リテラルに存在する場合、それは文字列の一部となります。

  Pythonのコメント例

実際にどのようにコメントをすれば良いのかは、以下のコードを見ると分かりやすいです。

name = "tanaka" # コメント
id = 100 # コメント
data = "#123" # ここからコメント

また、関数でコメントを書きたい場合は、以下の様に書きます。

# This function adds the two numbers
def add(x, y):
    return x + y

また、Pythonのクラスでコメントを書きたい場合は、以下の様にすればOKです。

# This class provides utility functions to work with Strings
class StringUtils:
          def reverse(s):
            return ''.join(reversed(s))

Pythonで複数行にまたがるコメントの書き方

コードを書いていると、コメントを1行にまとめると、かえって読みづらくなる場合があります。

この場合、コメントを複数行に分割することができます。

複数行のコメントを書くには、すべての行の前にハッシュ(#)を付けなければなりません。

# 1. reverse(s): returns the reverse of the input string
# 2. print(s): prints the string representation of the input object
class StringUtils:
          def reverse(s):
            return ''.join(reversed(s))

          def print(s):
            print(s)

Pythonのdocstring(ドキュメンテーション文字列)を複数行として書く

Pythonで複数行のコメントを書く場合は、ドキュメンテーション文字列を使う方法もあります。

docstring(ドキュメンテーション文字列)は、二重引用符（””）で囲まれた文字列で書きます。

関数やクラスの宣言のすぐ下に定義する必要があります。

それでは、Pythonのドキュメンテーション文字列の例をいくつか見てみましょう。

def foo():
          """foo関数のコメント
          この関数は何もしない"""
          pass
class Data:
          """ ドキュメンテーション文字列は1行だけでもOK"""

先ほど書いたドキュメンテーション文字列には、 __doc__ 属性を使ってアクセスする事ができます。

print(foo.__doc__)
print(Data.__doc__)

しかし、Pythonのドキュメンテーション文字列の目的は、ドキュメントを提供することなので、コメントとして使うのは止めた方が良いです。

もし、コメントを複数行に分けたいなら、すべての行の前にハッシュ文字を付けた方が良いです。