00:00
好,接下来呢,我们再说一个函数的内容啊,函数的东西其实还挺多的,哎,我们叫做一个文档字符串啊文档字符串参数的东西就这么多了是吧?接下来我们继续来说这个函数,那什么叫文档字符串呢?那说它之前呢,我们先说一个函数,我们叫做一个help,诶help是我们这个Python中的一个,这个内置函数啊,内置函数help什么意思?哎,帮忙是吧,帮忙如果再翻译的指导点救命是吧,当你掉水里的时候,你啊help help救了我对吧?在这呢,Help就是帮助的意思啊,帮助意思,那帮助我们什么?哎,我们通过这个help,诶可以干嘛呢?诶,Help函数,诶可以查询我们这个什么呀,哎,我们一些,哎,我们这个pthon中。哎,Python中的函数的用法,函数的用法,那这里边我们来说一下它怎么用的啊,语法是什么呢?非常简单,就是help里边传的是我们函数对象,一定注意传的是函数对象,比如说你想获取到我们这个print函数用法,哎,你就直接什么呢?Help,诶里边传一个什么呢?哎,Print,注意直接传对象,不要加括号啊,不要加括号,那这样就可以什么呢?哎,就可以获取我们这个print的函数的使用说明,哎使用说明咱们直接看效果啊,我们这一执行,哎这一看,诶你看help on build in function内建函数print in modelle,这个building in,在这个build in这个模块中啊模块我们待会再说不管它,然后print这是函数的结构,然后在这儿print参数,对吧,诶value,然后这块是一个可以传多个参数对吧,省略号,然后这个哎什么end呀,这个S呀,然后这个等等。
01:48
Flash等于什么,包括它的默认值是不是都给你写好了,哎,默认值都给你写好了,然后再看下边是不是有一个描述啊,哎,描述叫什么呀?哎,Print the values,诶,To a啊把这个值啊,Value嘛,省略号values对吧,Values to a stream,把这些值打印到一个流中,或者是什么呀,或者是系统的标准输出啊,默认的啊,默认的,然后它的一个介绍是吧,File这个参数是干嘛的,File这个参数干嘛的,然后这个N的这个参数干嘛的,Fla这个参数嘛的,每一个参数是不是会有一个描述啊哎,就是说当我们用到一些我们不懂的这个这个这个函数的时候,用的不太熟的一函数的时候,通过help我们是不是就可以查看这个说明啊,哎,查看说明啊,这是么?Help一个作用,但是这个是我们系统的内置函数对吧?那假如说我这有一个自己定义的函数,我叫一个FN,随便写一个,里边有个A有个B有个C,然后呢,我们这来写一个,哎,来写一个什么呢?我就直接return一个十,随便写一个啊随便写一个,那现在假如我想获取一下这个函数。
02:48
对话行不行呢?哎,当然也是没问题的,我直接help一个FN啊,Help一个FN在这里,我这一执行,诶也获取到了,也显示信息了,是吧?Help on function Fn in model men啊在men主要这个模块中,然后function nc,哎就把这函数的结构给我显出来了,它没有刚才我们看到print后边跟的那些说明吧,哎,没有那些说明,那我们先说为什么没有啊?哎,很简单,你没写对吧?因为我在这儿没有写说明,所以在这是不是就显示不出来说明啊,而当我们去打印print,它有说明的时候,是不是因为print里边有说明啊?哎,那我们先说一下,我们这里是有说明好还是没说明好?哎,很明显当然是有说明好,因为我们在开发的时候,我们往往都是一个多人协作的一个开发,也就是说你定义的函数别人可能会用,同样别人定义的函数,你是不是可能也需要去使用啊,诶也需要去使用,那这样当你。
03:48
去用别人的函数,或者别人在用你的函数的时候,而你现在是不知道怎么用的情况下,是不是最好就要有一个说明啊,哎,所以注意我们在写函数的时候,一定要去写一个说明,那怎么写说明,那这就是我们要说的一个东西,叫做文档字符串,文档字符串哎,Dog string啊dog和string,哎dog string啊string,那文档字符串是干嘛的啊,我们说了,哎文档在我们这个定义函数时啊,可以在什么呢?在函数内部来编写我们这个文档字符串,那文档字符串它是什么呢?就是我们那个函数的一个什么呀,说明啊,就是函数说明,诶当我们编写了这个文档字符串时啊,字符串时我们就可以什么呢?诶就可以通过我们这个help,诶,Help函数来查看我们这个函数的一个说明啊说。
04:48
啊,那现在我们来看文档字符串怎么编写,哎文档字符串非常简单,哎哎,其实什么呢?诶其实哎我们直接在我们函数的这个什么呀,诶第一行。
05:04
哎,写一个什么呀,写一个字符串,哎,它就是什么呀?哎,就是文档字符串直接在第一行,你说我来两对单引号也行,来两对双引号也行,就是一个字符串写第一行,但是一般的话我们都会用三重引号,为什么用三重呢?因为你用两个是不是只能写一行啊,你用这个只能写一行,所以我们一般都是什么呀,三个引号,为什么用三个引号啊,我们这个长字符串它是不是可以跨行写啊,哎,括行写,那在这儿你就可以写了,诶那这里,诶这是一个这个文档字符串的一个示例啊,这是一个文档字符画示例,在这儿你就可以写了啊,你写了你可以写什么呀?诶你可以往下写是吧?哎,我们这个函数的这个,哎作用是什么什么什么什么,然后在这可以写函数的这个参数是什么什么什么对吧,有什么呀,哎A这个参数,哎它的什么呀,哎作用是什么,然后什么呀,类型是什么等等等等,后边是不是还有这个什么呀?诶B诶然后还有什么呀。C作。
06:04
作用类型还有什么呀,诶默认值啊,默认值等等这些东西啊,等等这些东西这一保存,那这个就是一个文档字符串,这个时候我们再看这个help Fn啊,我们这一执行走一个,这时候是不是就描述了,哎这时候就描述了,哎或者说别人通过help可以来查看这个描述,或者说他是不是可以直接看源码就可以看到这记号啊,就记绍了啊这就是文档字符号的一个作用,但是它不是强制的,但是最好养成一个什么呀,养成一个编写文档字符号的一个习惯,诶帮助你理解,也帮助什么呀,诶帮助别人去理解,它是一个利人利己的,对吧,利人利己,当然这个文档字符片,这也是一个我们最基本的一个用法,最常见的一个用法,当然我们如果还要用的话,还要再写的复杂一点,我们可以干嘛呢?你现在来看我们这ABC是不是没有,我们光看到这函数,我如果不看这个文档字符串的话,我是不知道AB。
07:05
DC要传什么类型的值的,我不知道A是需要印呢还是整,是这个字符串还是布尔值,哎,是需要什么?其他值是需要一个序列还是需要一个字典,我们在这里是不是看不出来呀?那这时候怎么办?我可以在A后边写一什么呢?写一个冒号,一个int,那B后边,比如它需要一个布尔值,我就写一个Bo LC需要一个字符串,我就写一个什么呀,Str,那这什么表示什么意思?表示的是A需要的是一个整形,B需要的是一个布尔值,而C需要的是一个什么呢?是一个字符串,通过它我就可以看出什么呀,我这需要的一个类型,但是注意这儿只是一个什么呀,只是一个描述,没有其他任何作用,它没有强制性,不是说你这写了一个int就要求传int了,没有,就是一个描述,这个时候你再看文档字符串,你是不是能看出它需要什么类型了,哎,就更清晰了,甚至你可以在什么呢?哎,你看这儿我写一个C冒号SCR,还有同学说了,假如说我这C有默认值怎么办呀,有默认值你可以。
08:05
直接写等于一个这个hello啊等于hello,那这里边就指定好了默认值,我们就不用再写空格了是吧?直接写等于号,那就等于什么呀,它的默认值就是什么了,就是hello啊,就是hello也可以什么呢?在括号后边你写一个这么一个东西,这写什么呢?写一个str,这表示什么意思?哎,这表示我们函数的返回值是一个什么呀,字符串,诶,当然我这返回的是一个int是吧,我写同一一点,我也写一个int,表示我返回的是一个什么呀,整形这里指定是一个返回值,当然这些值都不是强制的,它就是一个描述性的,所以这一执行的话,哎,就这么一个,那通过这我就能看到啊,A是in的,B是布尔值,C是字符串,默认值是hello起不都行对吧?然后返回值是一个int,然后再加上这个描述,我这函数是不是就特别清晰了,哎,这样你自己在用你的函数,或者是别人在用你的函数的时候,一定哎会对你什么呀,诶心生感激,一定会觉得这哥们儿,我天呐,太专业了是吧,太讲究了,这个人啊,太讲究了,所以这个诶是一个他并不。
09:05
是一个强制要求,但是它是一个什么呀?哎,好的习惯诶,尽量把这东西写的清楚一点啊,清楚一点,然后还有一点啊,还有一点啊,其实我们Python官员文档呢,还给我们提这个要求,要求什么呢?我们这个文档字符串尽量干嘛呢?诶以这个英文来编写,诶英文因为它是什么呀,世界通用的语言来编写,但是这个东西对我们来说意义不是特别大呀,因为我们大部分的开发人员在我们中国,我们都是什么呀,在中国的公司工作,也就是说我们的工作环境里都是什么呀,中国人,那既然都是中国人,我们就没有必要用英文再去写这个文档字片了,就用纯中文就可以了,但是会有一部分同学,你做的项目可能是对外的,诶可能是对美的,诶对日对韩的这些项目,那这个时候你就要考虑到你在开发过程当中,有没有和其他的程序员,其用其他源的程序员沟通的一个必要,如果有,如果有涉及到对外开发,那这个注释尽量写什么,尽量使用。
10:05
英语来写啊,尽量使用英语来写,但是这个根据你的开发环境来来定啊,来定好,那这就是我们说的文档字符串啊,这是最基本的写法,然后这是一个这个增强的补充的一个写法啊,补充一份好,我们这儿还是来停一下。
我来说两句