它如何工作
在函数的第一个逻辑行的字符串是这个函数的文档字符串。注意,DocStrings也适用于模块和类。
文档字符串的惯例是一个多行字符串,它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。 强烈建议在函数中使用文档字符串时遵循这个惯例。
可以使用__doc__(注意双下划线)调用printMax函数的文档字符串属性(属于函数的名称)。
如果你已经在Python中使用过help(),那么你已经看到过DocStings的使用了!它所做的只是抓取函数的__doc__属性,然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。
自动化工具也可以以同样的方式从你的程序中提取文档。因此,强烈建议 对所写的任何正式函数编写文档字符串。随Python发行版附带的pydoc命令,与help()类似地使用DocStrings。