Python形参和实参_文档字符串_函数的注释

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

1 形参和实参

形参和实参的要点：

• 圆括号内是形式参数列表，有多个参数则使用逗号隔开
• 定义时的形式参数不需要声明类型，也不需要指定函数返回值类型
• 调用时的实际参数必须与形参列表一一对应

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

def printMax(a,b):
  '''实现两个数的比较，并返回较大的值'''
  if a>b:
    print(a,'较大值')
    return a
  else:
    print(b,'较大值')
    return b
​
printMax(10,20)
printMax(30,5)

执行结果：

20 较大值

30 较大值

上面的printMax函数中，在定义时写的printMax(a,b)。a和b称为“形式参数”，简称“形参”。也就是说，形式参数是在定义函数时使用的。 形式参数的命名要符合“标识符”命名规则。

在调用函数时，传递的参数称为“实际参数”，简称“实参”。上面代码中，printMax(10,20)，10和20就是实际参数。

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

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

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

def print_star(n):
  '''
   根据传入的n，打印多个星号
   :param n: 传入的数字
   :return:  n个星号拼接的字符串
   '''
  s = "*"*n
  print(s)
  return s
​
help(print_star)
print(print_star.__doc__)

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

Help on function print_star in module main:

print_star(n)

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

我们也可以通过函数名.__doc__直接获取到函数的文档字符串，自己进行打印。

print(print_star.__doc__)