如何使用python函数的文档字符串

如何使用python函数的文档字符串

这篇文章给大家介绍如何使用python函数的文档字符串,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。

文档字符串必须以三个单引号或者双引号包围,放在函数的第一行 函数的参数,返回值可以使用对应的类型修饰,但是仅仅起到一个修饰的作用,并不是强制的进行类型检查。 使用help()函数可以查看函数定义时的文档字符串等描述信息。

# 类型定义仅仅起到装饰作用,不是强制类型检查
def test(a: int, b: str) -> int:
    """
    文档字符串,必须放在函数的第一行
    :param a: 
    :param b: 
    :return: 
    """
    print("test")

help(test)

关于如何使用python函数的文档字符串就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。