Python コメント ブロック

そのマイコード |

コメントは、記述されたソース コードに関する詳細情報を提供するコンピューター プログラム内のテキストです.他のすべてのプログラミング言語と同様に、Python には、単一行コメント、複数行コメント、およびドキュメント文字列の 3 種類のコメントがあります.

Python コメント ブロックの概要

コメントは、ソース コードを説明するために使用されます.コメントは、主に次の目的で使用されます.

コードの読みやすさを改善する

コードのテスト

プロジェクトのコードまたはメタデータの説明

特定のコード ブロックの実行を防止する

たとえば、複雑なビジネス ロジック、数式、アルゴリズムなどを記述したとします.次に、コードの機能を説明するコメントを使用して文書化する必要があります.これにより、Python でのコードの読みやすさが向上します.

Python インタープリターは、コードの実行中にコメントを無視し、コードのみを解釈します.

Python のコメントの種類

Python で使用できるコメントには 3 種類あります.

単一行コメント

複数行コメント

ドキュメンテーション文字列、別名 docstring

これらのコメントを Python コードで使用する方法について、例を挙げて詳しく見ていきましょう.

一行コメント

ブロック コメントとも呼ばれる単一行コメントは、ハッシュ記号 (#) で始まり、その後に 1 つのスペースとテキスト文字列が続きます.

ハッシュ (#) は、1 行のコードでのみ機能し、複数行のコードでは機能しません.

Python での単一行コメントを示す例を見てみましょう.

# This is a single line comment example
print("Hello World")

インラインコメント

コメントをステートメントと同じ行に配置すると、インライン コメントになります.

単一行コメントと同様に、インライン コメントもハッシュ (#) 記号で始まり、その後にスペースとコメント テキストが続きます.

Python でのインライン コメントを示す例を見てみましょう.

print("Hello World") # This is a example of inline comment

複数行のコメント

通常、C、C#、Java などの他の言語では、以下に示すように複数行のコメントを付けることができます.

/* This is a comment block
which supports
Multi-line code */

しかし、これを Python で行うことはできません.

Python には、複数の行をコメント アウトする組み込みのメカニズムがありません.ただし、Python でこれを実現するにはさまざまな方法があります.

書きます 複数のハッシュタグ (#) を使用する

複数のハッシュタグを使用して、Python で複数行のコメントを書くことができます.ハッシュ記号 (#) を持つ各行は、1 行のコメントと見なされます.

# This is how we can acheive 
# Multi-line comments in Python
print("Hello World")

Python docstring

docstring とも呼ばれるドキュメント文字列は、モジュール、関数、クラス、またはメソッド定義の最初のステートメントとして発生する三重引用符で示される です.

注: docstring を作成するために、トリプル """クォーテーションを使用することもできます.

文字列リテラル 単一行のドキュメント文字列

単一行の docstring を示す例を見てみましょう. ** **

def Add(a,b):
    '''Takes two number as input and returns sum of 2 numbers'''
    return a+b

トリプル クォーテーション マークの内側は、関数 Add() の docstring であり、その定義の直後に表示されます.

複数行のドキュメントストリング

複数行の docstring は、三重引用符 (""") で始まり三重引用符 (""") で終わる複数行のコードにまたがることができます.

次の例は、複数行の docstring の使用方法を示しています.

def Add(a,b):
    '''Takes two number as input 
     Adds a and b
     Returns sum of a and b as output
    '''
    return a+b

print(Add(5,6))

投稿 は Python Comment Block に最初に表示されました.