[Day_28]函式与递回_(7)

函式的说明文件

可以在函式下方使用「'''」撰写函式的说明文件，说明文件可以跨好几行，直到找到下一个「'''」，使用「'''」会保留第2行以後所有开头的空格，如以下范例。

def min(a,b):
    '''使用min可以找出a与b较小的值
    Args:
        a:输入的第一个参数
        b:输入的第二个参数
    Returns:
        回传a与b中较小的值
    '''
    if a>b:
        return b
    else :
        return a

使用「help(min)」可以读取函式的说明文件，如下。

Help on built-in function min in module builtins:

min(...)
    min(iterable, *[, default=obj, key=func]) -> value
    min(arg1, arg2, *args, *[, key=func]) -> value
    
    With a single iterable argument, return its smallest item. The
    default keyword-only argument specifies an object to return if
    the provided iterable is empty.
    With two or more arguments, return the smallest argument.

使用「print(min.doc)」可以读取函式的说明文件，如下。

min(iterable, *[, default=obj, key=func]) -> value
min(arg1, arg2, *args, *[, key=func]) -> value

With a single iterable argument, return its smallest item. The
default keyword-only argument specifies an object to return if
the provided iterable is empty.
With two or more arguments, return the smallest argument.

我们可以善用函式的说明文件，让後续维护程序的程序设计师可以快速了解函式的用途与功能。

明天会继续介绍函式喔~~
大家加油~~