PythonDocstrings

Pythonプログラムでコードにコメントを付けて、コードの一部を理解することができます。ただし、コメントとコメントのさまざまな部分を検索するには、search（CTL + F）を使用する必要があり、多くの行をスクロールします。また、コードのセクション数などに関連付けられている特定の単語をすぐに知る方法はありません。この問題を解決するために、関数、モジュール、クラス、またはメソッドの定義の直後に文字列にアクセスするpythonDocstringがあります。

Docstringを印刷する

__doc__属性は、Pythonオブジェクトの定義の直後に宣言されると、Pythonオブジェクトの名前に自動的に関連付けられます。それを明確にする以下の例。

例

def Add_nums(x):
   '''Ada a number to itself.'''
   return x + x
print(Add_nums.__doc__)

出力

上記のコードを実行すると、次の結果が得られます-

Ada a number to itself.

単一行と複数行のドキュメント

1行のdocstringは1行であり、説明しすぎないようにする必要があります。これらは、文字列の最初と最後で3重引用符で囲まれています。上記の例は、1行のdocstringです。

複数行のdocstring

モジュールまたは関数をより詳細に説明する必要がある場合があります。その場合、複数行のdocstringを使用します。 1行のdocstringのように要約行が表示され、次に空白行が表示され、その後にさらに詳細な説明が続きます。

例

def Fibonacci(n):
   '''The Fibonacci numbers are the numbers in the following integer sequence.
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, .'''
   return x + x
print(Fibonacci.__doc__)

出力

上記のコードを実行すると、次の結果が得られます-

The Fibonacci numbers are the numbers in the following integer sequence.
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, .

組み込みのPythonオブジェクトのDocstring

クラス名と__doc__を使用すると、関数やモジュールなどのPythonオブジェクトに関連するドキュメントに簡単にアクセスできます。

例

print(list.__doc__)

出力

上記のコードを実行すると、次の結果が得られます-

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list.
The argument must be an iterable if specified.

Docstringのインデント

docstringの最初の行（つまり、最初の改行まで）のインデントは重要ではなく、削除されます。 docstringの後の行の相対インデントは保持されます。 docstring全体は、最初の行の引用符と同じようにインデントされます。