DocStringsLes DocStrings sont un outil important pour expliquer et documenter les programmes, ce qui aide à rendre la documentation de votre programme plus simple et plus facile à comprendre.
Nous pouvons utiliser une paire de triples guillemets simples sur la première ligne du corps de la fonction'''ou une paire de triples guillemets doubles"""pour définir une docstring.
Vous pouvez utiliser__doc__(notez les doubles underscores) pour accéder à l'attribut docstring de la fonction.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def function():
''' dites quelque chose ici！
'''
pass
print (function.__doc__) # Appel de doc
La sortie est :
say something here！
DocStringsConvention de docstring : la première ligne décrit brièvement le but de la fonction, la deuxième ligne est vide, et la troisième ligne contient une description détaillée.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def printMax(x,y):
'''Affiche le maximum de deux nombres.
Les deux valeurs doivent être des entiers.'''
x=int(x)
y=int(y)
if x>y:
print(x,'Maximum')
else:
print(y,'Maximum')
printMax(3,5)
print (printMax.__doc__) # Appel de doc
La sortie est :
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。