2021-03-01

一种python函数解释格式（来源于Lisa Taxue的教程）

尽管您当然可以在不使用备注文档的情况下编写函数代码，但要养成总是包含解释备注的习惯。相信我——你会很高兴你这么做的，任何使用你的代码的人都会非常感激你给的任何提示。解释字符串简要描述了代码的功能;在你写完代码几周后，它会提醒你你做了什么。此外，您可以使用它输出帮助消息——使用 help() 让其他人知道程序的功能。
你应该定义输入和输出变量以及函数的作用。
形式如下：
第一行解释函数用途
parameters： 定义变量类型及解释变量
returns：定义输出类型及解释输出结果

def degrees_to_radians(degrees):  
    """
    converts degrees to radians
    Parameters:
    ___________
        degrees : float
            degrees to convert to radians
    Returns:
    ________
        radians : float
            degrees converted to radians
    """
    radians=degrees*gimmepi()/180.
    return radians
print ('42 degrees in radians is: ',degrees_to_radians(42))