python学习知识点补充-----函数文档

在定义函数时,为了使代码更加易读,我们应该养成写函数文档的好习惯。那么函数文档怎么写?怎么调阅?举例子说明:

def FuncDoc():
    '''函数文档一般用三引号定义在此处。(注意缩进!)函数文档用来描述函
    数的属性、功能等特性,方便阅读者理解。比如该函数没有返回值,仅仅输
    出一条语句。'''
    print('Hello world!')

函数文档可以用两种方法进行调阅:
1.使用help()函数,语法:help(函数名)

help(FuncDoc)

运行结果:
2.使用函数的doc属性,语法;函数名.__doc__
 【注意!】上面语法中的下划线由两个短下划线组成!

print(FuncDoc.__doc__)

运行结果:

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值