第9章 函数-9.3 函数的文档注释

在第4章编码规范中已经详细介绍了什么是文档注释本小节将详细介绍函数的文档注释。无论是Python的内置函数或者是自定义函数都需要函数的设计者为其编写文档注释其通常位于函数内部所有代码的最前面。此外除了可以通过使用pydoc工具和help()函数来查看文档注释还可以通过使用__doc__属性来查看文档注释。示例代码如下# 资源包\Code\chapter9\9.3\0903.py def myFunc(parameter1, parameter2): 获取函数的形参 return (f输出第一个形参的值为{parameter1}第二个形参的值为{parameter2}) val myFunc(来自远方的老作者, Python) print(val) # 注意此处只需要书写函数名不需要添加小括号 print(myFunc.__doc__)上述代码的运行结果如图9-1所示。图9-1 使用__doc__属性的输出结果