logo

Python の複数行コメント

この記事では、Python の複数行のコメントの概念を詳しく説明し、Python プログラミング言語での複数行のコメント方法に関する包括的な定義と具体的な例を提供します。 パイソン

Python の複数行コメントとは何ですか?

Python の複数行コメントは、コード内で説明または文書化の目的で使用されるテキストまたはステートメントのブロックを指します。ハッシュ記号 (#) で示される単一行コメントとは異なり、複数行コメントは三重二重引用符 (``) または三重一重引用符 (`'') で囲まれます。これらのコメントは、コードに関する詳細な説明、ドキュメント、またはメモを提供するためによく使用され、複数行にまたがることもあります。 Python には複数行コメント用の特定の構文はありませんが、インタープリターは囲まれたテキストを無視するため、三重引用符を使用すると同様の効果が得られます。



Python の複数行コメントの種類

コードに Python の複数行コメントを追加するには 2 つの方法があります。それらは次のとおりです。

  • 連続した 1 行コメント
  • 複数行の文字列をコメントとして使用する
  • バックスラッシュメソッドの使用

連続した単一行コメントを使用して Python で複数行をコメントアウトする

パイソン 、行のコメントにはハッシュ文字 (#) が使用されます。単線 Python でのコメント コードを説明するためにテキストだけである必要はありません。Python によるコードの実行を防ぐためにも使用できます。 Python で複数行のコメントとみなされるようにするには、ハッシュ文字を各行の前に配置する必要があります。

例: 連続する 1 行のコメント

ここで、最初の 2 行にはハッシュ文字 (#) が含まれており、インタプリタによって 2 行の実行が阻止されます。次に、Python コメントを出力し、最後に最後の行の実行を防ぎます。



Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

出力:

Python Comments>

複数行の文字列をコメントとして使用して Python で複数行をコメントアウトする

Python の複数行コメントは区切り文字 () で囲むこともできます。ここでも、区切り文字 () の間に空白があってはなりません。コメント テキストが 1 行に収まらないため、複数行にまたがる必要がある場合に便利です。このタイプの文字列リテラルは、どの変数にも割り当てられていないため、無視されます。 __doc__ を使用してこれらの文字列にアクセスできます。

例: 複数行の文字列をコメントとして使用する

複数行コメントは、複数行にコメントするために使用されます。最初の行は 1 行のコメントです。 2 行目と 3 行目は三重引用符 ( ) を使用してコメントできます。これにより、上記のコードの実行が妨げられます。最後に、出力に Mathematics が表示されます。ただし、これらの Python 複数行コメントが関数またはクラス シグネチャの直後に配置されると、これらは次のようになります。 ドキュメント文字列



Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

出力:

Mathematics>

バックスラッシュメソッドを使用してPythonで複数行をコメントアウトする

Python で複数行のコメントを作成する方法では、各行の末尾にバックスラッシュ (``) を使用して行継続機能を利用し、コメントを次の行に拡張することができます。この行継続方法は、連続する単一行のコメントや複数行の文字列などの他のアプローチよりも一般的ではなく、主にコードを読みやすくする目的で、コメントを複数行にまたがって区切る必要がある場合に使用されます。

: この例では、で始まるコメントは#>バックスラッシュ (>) 各行の末尾にあります。バックスラッシュは、コメントが次の行に続くことを示します。この方法は、長いコメントがある場合にコードの読みやすさを向上させるのに役立ちます。

Python3
# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

出力:

Hello, World!>

Python のドキュメント文字列

ドキュメント文字列 は Python の組み込み機能であり、Python モジュール、関数、クラス、メソッドで作成されたドキュメントを関連付けるために使用されます。これは、関数、モジュール、またはクラスのすぐ下に追加され、その動作を説明します。 Python では、docstring は、 Python __doc__ 属性。

例: Python の docstring

この例では、multiply() 関数が定義された後、三重引用符を使用して docstring コメントを宣言しました。次に、__doc__ 属性を使用して docstring を出力します。

math.random Java
Python3
def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

出力:

Multiplies the value of a and b>

Python のコメントと docstring の違い

Python コメントと Docstring の違いを見てみましょう。

コメント

ドキュメントストリング

# を使用して宣言されます。それらは次を使用して宣言されます
コードの可読性を高めるために使用されますPython のモジュール、関数、クラスについて説明します。
アクセスできません__doc__ を使用してアクセスできます。