Python对象的文档字符串(DocString):__doc__的写法和输出方法

本文介绍了 Python 中 DocString 的使用方法及其重要性。通过实例展示了如何在函数中添加 DocString 以及如何通过 .__doc__ 属性访问这些文档字符串。此外,还提到了 DocString 在 help() 函数中的应用。
摘要由CSDN通过智能技术生成

        Python有个特性叫做文档字符串,即DocString,这个特性可以让你的程序文档更加清晰易懂,在python的系统文件里,也都在使用这个特性。因此推荐每个Python爱好者都使用它。

       DocString是有自己的格式的。一般是放在自己函数定义的第一行,用‘’符号指示,在这‘’里面添加函数功能说明就可以了。这个说明可以使用.__doc__(注意前后都是双_)属性,将DocString特性print打印出来。如下:

def inputxy():
    '''this is my first test doc'''

    print "hello the world"
inputxy()
print inputxy.__doc__# print pirntXY's doc

输出内容如下:

hello the world
this is my first test doc

Process finished with exit code 0

DocSting的典型用法就是help()调用,它抓取DocString属性,清晰的给你展示出来。


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值