DocStringsドキュメント文字列は、プログラムを説明するための重要なツールであり、プログラムのドキュメントをよりシンプルで分かりやすくするのに役立ちます。
関数本体の最初の行で、3つの一重引用符のペアを使用できます。'''または3つの二重引用符のペア"""を使用してドキュメント文字列を定義できます。
次を使用できます__doc__(二重アンダースコアに注意)関数内のドキュメント文字列属性を呼び出します。
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def function():
''' say something here!
'''
pass
print (function.__doc__) # doc を呼び出す
出力結果は次のとおりです:
say something here!
DocStringsドキュメント文字列の使用慣例:その最初の行で関数の機能を簡潔に説明し、2行目は空行、3行目で関数の具体的な説明を行います。
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def printMax(x,y):
'''2つの数値のうち最大値を出力します。
2つの値は両方とも整数でなければなりません。'''
x=int(x)
y=int(y)
if x>y:
print(x,'最大')
else:
print(y,'最大')
printMax(3,5)
print (printMax.__doc__) # doc を呼び出す
出力結果は次のとおりです:
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。