各位小伙伴,不知道大家之前的基础教程学习的如何?
今天要给大家分享的是函数中的
DocStrings
什么是DocStrings?
它的全称是:Documentation Strings
不知道小伙伴们在写函数的时候是否有这样的困惑,调用几个函数还好说,因为我们能够记得住函数的调用方式和调用之后预期的结果。但是,在一个具有相当功能的程序中,我们需要调用很多函数,基本上如果不加注释的话,就会迷路,于是Python给我们提供了一个非常好玩的功能,就叫做DocStrings。
DocStrings的作用?
他可以输出在函数定义时预设的说明内容
例子?
请看下面的例子:
这个例子中,我们定义了一个非常简单的比较两数大小的函数,需要注意的是,在函数开始,我们用一对'''包含了一句话,这句话就是我们定义的DocStrings!
当我们运行函数的时候,会有如下输出:
这,好像和普通的函数没有什么区别,是的,但是我们要想知道这个函数是做什么的,就可以使用如下语句来调用DocStrings
如此,以后不明白这个函数是做什么的时候,就可以输出他的DocStrings进行查看,相当实用。
领取专属 10元无门槛券
私享最新 技术干货