68：形参和实参_文档字符串_函数注释

###形参和实参

形参和实参的要点，请参考上一节中的总结。在此不再赘述

【操作】定义一个函数，实现两个数的比较，并返回较大的值。

def printMax(a, b):
    """实现两个数的比较，并返回较大的值"""
    if a > b:
        print(a, '较大值')
    else:
        print(b, '较大值')

printMax(10, 20)
printMax(30, 5)

 输出结果：

D:\work\python\two\venv\Scripts\python.exe D:\work\python\two\mypy01.py 
20 较大值
30 较大值

上面的 printMax 函数中，在定义时写的 printMax(a,b)。a 和 b 称为“形式参数”，简称“形参”。也就是说，形式参数是在定义函数时使用的。 形式参数的命名只要符合“标
识符”命名规则即可。
在调用函数时，传递的参数称为“实际参数”，简称“实参”。上面代码中，printMax(10,20)，10 和 20 就是实际参数。

###文档字符串(函数的注释)

程序的可读性最重要，一般建议在函数体开始的部分附上函数定义说明，这就是“文档字符串”，也有人成为“函数的注释”。我们通过三个单引号或者三个双引号来实现，中间可以加入多行文字进行说明。

【操作】测试文档字符串的使用

def print_star(n):
    """根据传入的 n，打印多个星号"""
    print("*" * n)

help(print_star)

输出结果：

D:\work\python\two\venv\Scripts\python.exe D:\work\python\two\mypy02.py 
Help on function print_star in module __main__:

print_star(n)
    根据传入的 n，打印多个星号

我们调用 help(函数名.__doc__)可以打印输出函数的文档字符串。执行结果如下：

def print_star(n):
    """根据传入的 n，打印多个星号"""
    print("*" * n)


help(print_star)

print("==============================")

help(print_star.__doc__)

输出结果：

D:\work\python\two\venv\Scripts\python.exe D:\work\python\two\mypy02.py 
Help on function print_star in module __main__:

print_star(n)
    根据传入的 n，打印多个星号

==============================
No Python documentation found for '根据传入的 n，打印多个星号'.
Use help() to get the interactive help utility.
Use help(str) for help on the str class.