案例仿写，Python打印两个最大值的整数

今天教大家一个方法，利用Python文档字符串（documentation strings）的特性，来全面的分析，一个函数返回文档字符串，打印出两个最大值的整数。

以下就是文档字符串举例：

1. def printMax(x, y):

2. '''打印两个数中的最大值。

3. 两个值必须是整数。'''

4. x = int(x) # 如果可能，转换为整数

5. y = int(y)

6. if x > y:

7. print(x, '最大')

8. else:

9. print(y, '最大')

10. printMax(3, 5)

11. print(printMax.__doc__)

输出：

5 最大

打印两个数中的最大值。

两个值必须是整数。

首先分析下这段代码，它是如何工作：

函数的第一个逻辑行的字符串是那个函数的文档字符串。

文档的以贯例是多行字符串，第一行以大写字母开头以句点(.)结束(注：中文在 V3.3中也可以)，第二行是空行，从第三行开始是详细描述。强烈建议，为你重要的函数写文档字符串要遵循此贯例。

我们可以使用函数的__doc__(注意，双下划线)属性(属于名字的)访问printMax函数的文档字符串。只要记住，Python把一切任何事情作为一个对象对待，这也包括函数。我们将在类这一章学习关于对象的更多知识。

如果你在Python中已经使用过 help()，那么你已经看到如何使用文档字符串了!它所做的仅仅是获取函数的 __doc__ 属性，并以一个整洁的方式显示给你。你可以在上面的函数— —在你的程序中仅包括 help(printMax)尝试一下。记得按下 q键，退出help。

自动化工具可以从你的程序中以这种方式检索文档。因此，我强烈建议，为你写的任何重要函数使用文档字符串。来自 Python的自动化工具 pydoc命令使用文档字符串的工作原理类似于help()。