内容来自:https://blog.csdn.net/LittleHuang950620/article/details/82181234。仅作为个人笔记整理
函数文档
函数第一段注释将会被作为函数文档。以前用PLY(Python的Lex,YACC)时甚至会需要在里面提供推导式。
def func(x):
"""this is a doc
doc line two
"""
return x
print(func.__doc__)
结果:
this is a doc
doc line two
参数、返回值注释
Python作为强类型的动态语言,问题在于
- 定义函数时如果变量类型不对不会报错,运行时才会报错
- 不知道要传什么类型的参数
def func(x: int) -> str:
"""this is a doc
doc line two
"""
return str(x)
print(func.__annotations__)
结果
{'x': <class 'int'>, 'return': <class 'str'>}
变量类型注释
但是也只是提醒
a: int = 100
print(a)
a: int = "123"
print(type(a))
100
<class 'str'>