1、给函数增加注释
鼠标点击函数名处,等待附近出现黄色小灯泡,
点击它会展开,
再点击框中的“Insert documentation string stub”,
会出现如下几行,
在第一行三个双引号后面写上函数函数的功能。
下面包含param的几行是你定义的变量,在每行的冒号后面写上变量的注释。
2、查看函数注释
在后面调用函数的地方,点击函数名,然后按Crtl+Q,会以弹窗形式显示注释。
下面附上本次示例的代码
def test(char, times):
"""输出分割线
:param char:组成分割线的字符
:param times:每条线包含几个字符
"""
print(char * times)
def test2(char, times, row):
"""循环输出多行分割线
:param char: 组成分割线的字符
:param times: 每条线包含几个字符
:param row: 输出多少行分割线
"""
i = 0
while i < row:
test(char, times)
i += 1
test2("&", 2, 2)