python文档字符串和注释的区别_Python初学者注释：返回值和文档字符串,笔记

首先使用函数制作一个任意数相加的小程序

def a(*nums):

b=0#用于保存结果

for i in nums:#遍历元组，将元组中的数进行累加

b+=i

print('结果为',b)

a(1,2,3)

结果为 6

返回值

就是函数执行后返回的结果，通过return来指定函数的返回值

。

将函数的返回值赋予给一个变量，即可看到函数的返回值。拿上述例子来说：

def a(*nums):

b=0

for i in nums:

b+=i

print('结果为',b)

return 233

a(1,2,3)

结果为 6

直接将返回值写入，是查看不到任何效果的，需要将其赋值，用个简单的例子测试一下

def test():

return 233

a=test()

print('函数返回值为:',a)

函数返回值为: 233

在return后面跟什么，就会返回什么，可以跟任意的对象，甚至是一个函数，通常用于代码执行完成后的友好输出。

def test():

return '代码执行完成'

a=test()

print('函数返回值为:',a)

函数返回值为: 代码执行完成

如果仅仅写了return或者不写return，则相当于return None。

def test():

return

a=test()

print('函数返回值为:',a)

函数返回值为: None

注意，在函数中，return代表结束的意思，其后面的代码都不会执行，一旦匹配到，则直接结束代码。

def test():

return '还没有结束'

print('over')

a=test()

print('函数返回值为:',a)

函数返回值为: 还没有结束

在函数中，循环语句中的终止循环依然可以使用，当循环结束后才会使用返回值。

def test():

for i in range(5):

print(i)

if i == 3 :

return '结束'

a=test()

print('函数返回值为:',a)

0

1

2

3

函数返回值为: 结束

加上break终止循环

def test():

for i in range(5):

print(i)

break

if i == 3 :

return '结束'

a=test()

print('函数返回值为:',a)

0

函数返回值为: None

可以看到，如果return返回值在循环语句中，也会被终止循环给结束掉，把他放到外围即可。

def test():

for i in range(5):

print(i)

if i == 3 :

break

return '结束'

a=test()

print('函数返回值为:',a)

0

1

2

3

函数返回值为: 结束

查看返回值还有另外一种方式，通过print()函数查看

def test():

for i in range(5):

print(i)

if i == 3 :

break

return '结束'

print('函数返回值为:',test())

0

1

2

3

函数返回值为: None

文档字符串

help()是python中的内置函数，通过help()函数可以查询python中的函数的用法

语法：help(函数对象),例如：获取print()函数的使用说明

help(print)

Help on built-in function print in module builtins:

print(...)

print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

Prints the values to a stream, or to sys.stdout by default.

Optional keyword arguments:

file: a file-like object (stream); defaults to the current sys.stdout.

sep: string inserted between values, default a space.

end: string appended after the last value, default a newline.

flush: whether to forcibly flush the stream.

在定义函数时，可以在函数内部编写文档字符串，文档字符串就是函数的说明，当我们编写了文档字符串时，就可以通过help()函数来查看函数的说明。

直接在函数的第一行写一个字符串就是文档字符串，通常使用三引号进行编写

def test():

'''

这是文档字符串

'''

help(test)

Help on function test in module __main__:

test()

这是文档字符串