1. 函数文档
前面已经有说过了,在定义函数的时候,可以在函数的第一行输入一个字符串,这个字符串就代表了这个函数的注释。
这个对函数的描述被保存在函数的属性里,可以用funcname.__doc__调出来。
例:
print(sum.__doc__)
Return the sum of a 'start' value (default: 0) plus an iterable of numbers
When the iterable is empty, return the start value.
This function is intended specifically for use with numeric values and may
reject non-numeric types
sum.__doc__
"Return the sum of a 'start' value (default: 0) plus an iterable of numbers\n\nWhen the iterable is empty, return the start value.\nThis function is intended specifically for use with numeric values and may\nreject non-numeric types."
sum函数是一个内建函数,我们可以直接调用出它的函数注解。
注意一般函数文档都是用”“” “”” ,三引号来括起来,因为可以随意换行,看起来更方便,所以print打印出函数注解会自动换行,直接输出的话,遇到换行符就不会生效。
我们自己也可以写函数文档:
def funcname():
"""I miss a beau