DocStringsDocStrings sind ein wichtiges Werkzeug zum Erklären und Dokumentieren von Programmen und helfen dabei, Ihre Programmdokumentation einfacher und leichter verständlich zu machen.
Wir können ein Paar dreifacher einfacher Anführungszeichen in der ersten Zeile des Funktionskörpers verwenden'''oder ein Paar dreifacher doppelter Anführungszeichen""", um einen Docstring zu definieren.
Sie können__doc__(beachten Sie die doppelten Unterstriche) verwenden, um auf das Docstring-Attribut der Funktion zuzugreifen.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def function():
''' Sag hier etwas！
'''
pass
print (function.__doc__) # Doku aufrufen
Die Ausgabe ist:
say something here！
DocStringsDocstring-Konvention: Die erste Zeile beschreibt kurz den Zweck der Funktion, die zweite Zeile ist leer, und die dritte Zeile enthält eine ausführliche Beschreibung.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def printMax(x,y):
'''Gib das Maximum von zwei Zahlen aus.
Beide Werte müssen ganze Zahlen sein.'''
x=int(x)
y=int(y)
if x>y:
print(x,'Maximum')
else:
print(y,'Maximum')
printMax(3,5)
print (printMax.__doc__) # Doku aufrufen
Die Ausgabe ist:
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。