Python 函数嵌套的案例演练 和 给函数增加专业文档注释的技
2022-05-16 本文已影响0人
可可里西
体会一下在工作场景中多变的需求:函数嵌套的演练 - 打印分隔线
需求一:
定义一个print_line函数能够打印*组成的一条分隔线。
代码:
def print_line():
print("*" * 50)
print_line()
执行结果:
![](https://img.haomeiwen.com/i6727033/2b4ace19c7d35463.png)
需求二:
定义一个函数能够打印由任意字符组成的分隔线。
代码:
def print_line(char):
print(char * 50)
print_line('-')
执行结果:
![](https://img.haomeiwen.com/i6727033/c07e48e3c443a56b.png)
需求三:
定义一个函数能够打印重复次数组成的分隔线。
代码:
def print_line(char, times):
print(char * times)
print_line('+', 30)
执行结果:
![](https://img.haomeiwen.com/i6727033/952e056f0b33c6ec.png)
需求四:
定义一个函数能够打印5行的分隔线,分隔线要求符合需求3
提示:工作中针对需求的变化,应该冷静思考,不要轻易修改之前已经完成的能够正常执行的函数。
代码:
def print_line(char, times):
print(char * times)
def print_lines():
row = 0
while row < 5:
print_line('+', 30)
row += 1
print_lines()
执行结果:
![](https://img.haomeiwen.com/i6727033/386563277361e91f.png)
五、增加多行分隔线函数的参数
在上面的需求四中,函数的参数是写死的,显然不合适,因为我们封装的函数应该更加灵活具有通用性。
代码:
def print_line(char, times):
print(char * times)
def print_lines(char, times):
row = 0
while row < 5:
print_line(char, times)
row += 1
print_lines('-', 20)
执行结果:
![](https://img.haomeiwen.com/i6727033/4797081441a4ebdf.png)
在封装函数的时候,应该尽量让函数更加具有通用性和灵活性,,而函数想要具有通用性和灵活性,就应该把函数内部可变的数据都改成参数的形式,由调用者调用函数时从外部传递进来,这样可以根据传递进来的数据进行变换。
六:[扩展] PyCharm给函数增加文档注释
![](https://img.haomeiwen.com/i6727033/1b5a12f0d72b12cf.png)
6.1 给函数增加文档注释
方法:
利用三组双引号,在每三个双引号中填写注释
怎么查看这个注释:
选中函数调用的那行代码,按住快捷键Ctrl+Q就可以查看给函数添加的文档注释了。
6.2 给函数的形参增加文档注释
![](https://img.haomeiwen.com/i6727033/c2f25f9af3052658.png)
方法步骤:鼠标选中函数名,在左边会出现一个黄色灯泡,鼠标悬停在上面会出现选项,我们选择蓝色底纹的那个(插入短的字符串代码)直接单击后会出现以下的注释,然后我们再编写想要的注释。
![](https://img.haomeiwen.com/i6727033/79e20c6a7d8dabda.png)
编写好的注释样子:
编写好注释后依旧选中调用函数那一行,然后按住快捷键Ctrl+Q调用出注释,会发现给我们标注的明明白白的。
使用这个技巧就可以给函数添加非常专业的注释了。
![](https://img.haomeiwen.com/i6727033/2b7da86f7933ded0.png)
文章借鉴来源:Python自学网