6.1 函数的定义和调用
6.1.1 定义函数
定义函数的格式如下:函数名采用合适的标识符,小括号必须要有。
def 函数名():
代码
6.1.2 调用函数
定义了函数之后,就相当于有了一个具有某些功能的代码,想要让这些代码能够执行,需要调用它。调用函数时通过函数名()即可完成调用。
通常调用的函数称为主调函数,被调用的函数称为被调函数。
主调函数和被调函数是相对的,例如函数A调用了函数B,函数B又调用了函数C,那么在A调用B这次函数调用中,A是主调函数,B是被调函数。而在B调用C这次函数调用中,B是主调函数,C是被调函数。
可见:一个函数是主调函数还是被调函数,取决于在调用中的位置,和其他方面没有关系。
例如:6.1-函数的定义和调用.py
# 函数的定义和调用
# 定义一个函数,能够完成打印信息的功能
def print_info():
print('=' * 20)
print('abc')
print('=' * 20)
print('函数外部')
# 定义完函数后,函数是不会自动执行,需要调用它才可以
print_info()
结果为:
函数外部
====================
abc
====================
6.1.3 函数文档字符串
函数文档字符串documentation string(docstring)是放在函数开头,用来解释其内容的字符串。实际上就是这个函数的帮助文档。一般里面可以包含如下信息:
包含函数的基础信息
包含函数的功能简介
包含每个形参的类型,使用等信息
使用
必须在函数的首行;
通常使用三引号的多行字符串(也可以是一行);
函数文档的第一行一般概述函数的主要功能,第二行空,第三行详细描述。
查看方式
在交互模式下可以使用help查看函数的帮助文档,该界面会跳到帮助界面,需要输入q退出界面。
使用__doc__属性查看,该方法的帮助文档文字直接显示在交互界面上。
例如:6.2-函数文档.py
# 函数文档的作用是对函数的内容加以说明
# 在函数的首行,使用字符串说明
def test():
"""
函数名:test
功能:测试函数文档
参数:无
返回值:无
"""
help(test)
执行结果为:
Help on function test in module __main__:
test()
函数名:test
功能:测试函数文档
参数:无
返回值:无