日度归档:2021年2月12日

Python中请简单介绍一下你们公司如何给函数编写注释信息的呢?


摘要:
下文讲述Python中函数编写注释的相关说明,如下所示:

我们都知道注释对一个函数非常重要,
那么编写好的注释,可方便其它同事更好的理解函数的用法,
及后续的错误排查和处理,
那么如何编写一个良好的函数注释呢?
下文将一一道来,如下所示:

 1.在函数def关键字下的第一行中,
    采用三个单引号或三个双引号,设置多行注释
     注释1:
        函数功能说明
        函数参数说明
        函数返回值说明

2.为函数的参数和返回值设置相应的参数注解

Python中函数类型注解指什么呢?


摘要:
下文讲述Python中函数注解的相关知识,如下所示:

Python函数注解是
Python3.5中引入的一个重要的概念
它主要是在函数定义时,对参数的类型和返回值的类型
做相应的说明,如下所示

Python中函数注解:
     1.对函数参数做类型
     2.对函数返回值做类型说明
 
Python函数注解注意事项:
     此类型只是说明,
     在运行时,不使用此类型对参数进行检查
    如:
     参数调用时,输入其它类型的参数,
   函数还会继续正常运行
     

例:
Python之函数函数注解的方式


#maomao365.com
#Python 函数注解的示例说明


#函数定义了参数的建议传入类型
#及函数的返回类型
def funTest(x:int,y:int)->int:
    return x+y

print(funTest(88,99))

#传入非int类型,函数正常运行
print(funTest("maomao","365.com"))


//输出
187
maomao365.com

Python中函数定义的方式有哪些缺点及如何避免呢?


摘要:
下文讲述Python中函数定义的缺点,如下所示:

Python中函数定义的缺点:
     1.变量类型不确定
     2.由于不做类型检查,所以运行可能出现问题
     3.由于不做类型检查,所以函数调用时无法知道具体的情况

如何避免Python中函数定义无类型的缺陷呢?

1.为函数加入DOCstrings,这样可通过阅读说明的形式了解其用法
2.为函数加入类型注解

例:
函数加入DOCStrings和函数注解的方式


#maomao365.com
#Python 函数注解及DOCStrings的示例说明

def funTest(x:int,y:int)->int:
    """
    :param x:int
    :param y:int
    :return:int
    """
    return x+y

print(help(funTest))
print(funTest(88,99))
print(funTest("maomao","365.com"))