python函数注释与函数声明

python注释

def  f(text:str, max_len:'int>0'=80) ->str:
  """在这里备注函数说明，help时会显示"""
  return true

"""
函数声明中，text:str
text 是参数 :冒号后面  str是参数的注释。
如果参数有默认值，还要给注释，如下写。
max_len:'int>0'=80

->str 是函数返回值的注释。

这些注释信息都是函数的元信息，保存在f.__annotations__字典中、

需要注意，python对注释信息和f.__annotations__的一致性，不做检查
不做检查，不做强制，不做验证！什么都不做。
"""
"""函数注释示例："""
def f(ham: 42, eggs: int = 'spam') -> "Nothing to see here":
    print("函数注释", f.__annotations__)
    print("参数值打印", ham, eggs)
    print(type(ham),type(eggs))

f("www")
返回信息：
函数注释 {'ham': 42, 'eggs': , 'return': 'Nothing to see here'}
参数值打印 www spam
 
解释说明：
注释的一般规则是参数名后跟一个冒号（：），然后再跟一个expression，这个expression可以是任何形式。

返回值的形式是 -> int，annotation可被保存为函数的attributes。


Google风格
"""
This is a groups style docs.

Parameters:
  param1 - this is the first param
  param2 - this is a second param

Returns:
    This is a description of what is returned

Raises:
    KeyError - raises an exception
"""

Rest风格
"""
This is a reST style.

:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""

引用
[1]https://blog.csdn.net/sunt2018/article/details/83022493