【Python】ダブルクォーテーションを複数使った記述について(三連引用符,docstring)

Pythonではダブルクォーテーション(文字列「”」のこと)を3つ続けて使うこと、三連引用符で変わった機能が使える

ダブルクォーテーションを3つ続けて使った機能(三連引用符)

docstringとしての利用

三連引用符を使うと複数行に対してPythonファイルにつける説明文であるdocstringを記述できる

docstringとコメント(#やシングルクォート三連符)とは厳密には別です

docstringはモジュールやクラス、関数の使い方を記述する際に利用する説明書がきに使う

それ以外は#やシングルクオート三連符を使ってコメントアウトすると良いでしょう

例)

def func(arg1, arg2):
    """概要

    詳細説明

    :param int 引数(arg1)の名前: 引数(arg1)の説明
    :param 引数(arg2)の名前: 引数(arg2)の説明
    :type 引数(arg2)の名前: 引数(arg2)の型
    :return: 戻り値の説明
    :rtype: 戻り値の型
    :raises 例外の名前: 例外の定義
    """
    val = arg1 + arg2
    return val

上記のような感じで関数の説明を書ける

三連引用符を使った文字列の定義

「”””」である三連引用符をで文字列を囲むとその文字列はPythonにおける文字列となる

これを使うと改行を表すエスケープシーケンスをエスケープすることなく文字列の中で記述できる

例)

msg = """\
おはよう。
お元気ですか。"""

print(msg)

>> おはよう。
>> お元気ですか。

コメント

タイトルとURLをコピーしました