Python中的DocStrings

DocStrings（文档字符串）是Python中的一个特性，它可被用于函数、模块和类。

它的作用是为程序添加注释，让程序更加的简单易懂（即增加程序可读性）。

例如可以在函数后书写DocStrings，用于解释函数的作用、参数的类型与意义、返回值类型与取值范围等。

def printMax(x,y):
	'''Print the maximum of two numbers. The two values must be intgers.'''
	x=int(x)
	y=int(y) 
	if x>y:
		print x,'is maximum'
	else:
		print y,'is maximum' 
printMax(3,5)
print printMax.__doc__
help(printMax)

可以采用print 函数名._doc_或者help()的方式来提取文档字符串。