Python Docstrings ( __doc__
) を記述する 2 つの方法の違いは何だろうと思っていました:
3 つの一重引用符:
''' Comment goes here '''
3 つの二重引用符:
""" Comment goes here """
後でドキュメントを生成する際にドキュメント文字列をフォーマットする方法に微妙な違いはありますか?
Python Docstrings ( __doc__
) を記述する 2 つの方法の違いは何だろうと思っていました:
3 つの一重引用符:
'''
Comment goes here
'''
3 つの二重引用符:
"""
Comment goes here
"""
後でドキュメントを生成する際にドキュメント文字列をフォーマットする方法に微妙な違いはありますか?
いいえ、同じです。唯一の違いは、最初のものには3つのエスケープされていない二重引用符のシーケンスを含めることができ、2番目のものには3つのエスケープされていない一重引用符のシーケンスを含めることができることです。(つまり、区切り文字が異なるため、区切り文字内で使用できる文字にわずかな違いがあります。)
Docstringは単なる通常の文字列であり、Pythonでは、文字列内で文字列区切り文字を使用できないことを除いて、異なる文字列区切り文字に違いはありません。
情報文書PEP 257 -- Docstring Conventions"""triple double-quotes"""
は、一貫性のために使用することを推奨しており、それらの例はすべて同じことを示しています:
一貫性を保つために、常に
"""triple double quotes"""
docstring を使用してください。docstring でバックスラッシュを使用するr"""raw triple double quotes"""
場合に使用します。Unicode docstring の場合は、 を使用しますu"""Unicode triple-quoted strings"""
。
一重引用符または二重引用符のどちらを使用するかは、実際には文体の問題にすぎません。これらの文字列からドキュメントを生成して公開する場合、フォーマットに違いはありません。
お好きなスタイルをお選びください。個人的には、Python ではどこでも一重引用符を使用しています。
ドキュメントには次のように記載されています。
"String literals can be enclosed in matching single quotes (') or double quotes (")."
どちらを使用するかは問題ではありません。重要なのは、自分の決定に固執することです。スタイルを選択し、それに固執することをお勧めします。