在定义函数时,为了使代码更加易读,我们应该养成写函数文档的好习惯。那么函数文档怎么写?怎么调阅?举例子说明:
def FuncDoc():
'''函数文档一般用三引号定义在此处。(注意缩进!)函数文档用来描述函
数的属性、功能等特性,方便阅读者理解。比如该函数没有返回值,仅仅输
出一条语句。'''
print('Hello world!')
函数文档可以用两种方法进行调阅:
1.使用help()函数,语法:help(函数名)
help(FuncDoc)
运行结果:
2.使用函数的doc属性,语法;函数名.__doc__
【注意!】上面语法中的下划线由两个短下划线组成!
print(FuncDoc.__doc__)
运行结果: