【小甲鱼零基础入门学python】学习总结之函数文档

>>> def MyfirstDef():
	('这是一个自定义的函数\n'
	 '用来说明函数文档\n'
	 '函数文档需要写在函数语句前面\n'     #需要注意的地方
	 '函数文档可以用MyfirstDef.__doc__来调用，要注意doc前后是双下划线\n'  #需要注意的地方
	 '函数文档也可以用help(MyfirstDef)来调用，而且这种形式显示的格式更清晰') #需要注意的地方
	print("这其实是一个函数文档的说明")
	'这一段是用来测试一下:写在程序语句后面，算不算函数文档内的内容，答案是 不算 '#需要注意的地方

# 还要注意要是多行内容，需要放在一个（）或者一个三引号里面。要是每一行用一个单引号或者一个双引号的话只有第一个引号里的内容是属于函数文档的。
>>> MyfirstDef()
	      
这其实是一个函数文档的说明
>>> MyfirstDef.__doc__
	      
'这是一个自定义的函数\n用来说明函数文档\n函数文档需要写在函数语句前面\n函数文档可以用MyfirstDef.__doc__来调用，要注意doc前后是双下划线\n函数文档也可以用help(MyfirstDef)来调用，而且这种形式显示的格式更清晰'
>>> help(MyfirstDef)
	      
Help on function MyfirstDef in module __main__:

MyfirstDef()
    这是一个自定义的函数
    用来说明函数文档
    函数文档需要写在函数语句前面
    函数文档可以用MyfirstDef.__doc__来调用，要注意doc前后是双下划线
    函数文档也可以用help(MyfirstDef)来调用，而且这种形式显示的格式更清晰

>>>