1、文档字符串
在编写大型程序的时候,我们经常需要定义很多个函数,以实现多个功能模块,有时我们会忘记某个函数是什么功能,这个时候我们可以使用文档字符串。Python中文档字符串是一种特殊的字符串注释,用于描述函数、类、模块等的功能和使用方法。文档字符串通常放在函数、类、模块的开头,用三个双引号(""")或三个单引号(''')括起来,例如:
动手练一练:
def add(x, y):
"""
文档字符串:
该函数可以将两个数字相加
参数:
x (int): 第一个参数
y (int): 第二个参数
Returns:
int: 返回 x + y
"""
return x + y
help(add) # 获取文档字符串的第一种方法
print("-------这是虚线-------")
print(add.__doc__) # 获取文档字符串的第二种方法
执行以上代码,输出结果为:
Help on function add in module __main__:
add(x, y)
文档字符串:
该函数可以将两个数字相加
参数:
x (int): 第一个参数
y (int): 第二个参数
Returns:
int: 返回 x + y
-------这是虚线-------
文档字符串:
该函数可以将两个数字相加
参数:
x (int): 第一个参数
y (int): 第二个参数
Returns:
int: 返回 x + y
上面的例子中,在函数内部可以看到文档字符串,这些文档字符串里面记录的都是函数具体实现的细节。文档字符串可以通过help()函数或__doc__属性两种方法获取到。文档字符串可以被调用,但是不会被解释器执行,也不影响程序的执行。
2、函数注释
Python中的函数注释主要用于说明函数的功能、参数和返回值,帮助其他开发者理解代码。函数注释是一个可选功能,它允许在函数的参数和返回值中添加注释内容,不会影响程序的执行。
函数注释的一般规则是:参数名注释可以在参数名后面跟一个冒号“:”,然后再跟一个类型提示;返回值注释则在函数名后面以“->”标记,然后再跟一个类型提示,描述函数的返回类型,这些类型提示是可选的,Python不会强制类型检查。例如:
动手练一练:
def add(a, b:int, c:"注释内容", d:"默认值为4"=4) -> float:
return a + b + c + d
print(add(1, 2, 3)) # 输出 1 +2 + 3 + 4 = 10
print("-------这是虚线-------")
print(add("你好", "!", "Py", "thon")) # 输出 你好!Python
执行以上代码,输出结果为:
10
-------这是虚线-------
你好!Python
上面的例子中,第一个参数“a”没有注释,第二个参数“b”带有数据类型为int(整数)的注释,第三个参数“c”带有一个字符串注释,第四个参数“d”带有字符串注释并且拥有默认值。函数的返回值用元数据float(浮点数)来注释,表明了函数的返回值为浮点型。运行时,Python解释器不会对这些注释添加任何的语义,不会影响程序的正常执行。上面的例子中,我们调用了两次函数add()都输出正常,所以注释对函数的执行没有任何影响。