DocStringsLas cadenas de documentación son una herramienta importante para explicar y documentar programas, ayudando a que la documentación de tu programa sea más simple y fácil de entender.
Podemos usar un par de tres comillas simples en la primera línea del cuerpo de la función,'''o un par de tres comillas dobles,"""para definir la cadena de documentación.
Puedes usar__doc__(nota: doble guion bajo) para llamar al atributo de cadena de documentación de la función.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def function():
''' say something here！
'''
pass
print (function.__doc__) # Llamar a doc
El resultado es:
say something here！
DocStringsConvención de uso de cadenas de documentación: la primera línea resume brevemente el propósito de la función, la segunda línea está en blanco y la tercera línea es la descripción específica de la función.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def printMax(x,y):
'''Imprime el valor máximo de dos números.
Ambos valores deben ser números enteros.'''
x=int(x)
y=int(y)
if x>y:
print(x,'Máximo')
else:
print(y,'Máximo')
printMax(3,5)
print (printMax.__doc__) # Llamar a doc
El resultado es:
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。