系统内置库文件模块文档内容

每一个函数都要编写说明文档，也就是这个函数是干什么的，怎么用，有什么要注意的，传入的参数是什么，返回值是什么等等。

要不然，时间长了，你根本不知道这个函数完成的功能是什么？即使你每一行都写明了注释，也是无济于事。

我们平时导入的一个库文件，可以通过help帮助命令来显示它的文档。

如上图所示，random模块的内容比较多，如果想要看源文件，可以见显示的最后一行。

翻了好几页，我们下面选取其中一个函数看下。

系统内置函数文档内容

randint函数，是根据选取的范围来，随机挑选一个其中的数字。

通过help函数把randint函数的说明文档内容显示出来。

根据库文件的源文件位置，在行366到行370处，找到了该函数的完整代码。和终端输出窗口的内容是一模一样的。

自定义函数文档内容

我们自己创建一个函数，该函数没有要执行的语句，只有在返回值给传了一个字符串。紧跟着函数名下，用两个三引号，相当于多行注释一样，这就是写明函数说明文档内容的所在。

用help函数显示时，函数名加上两个三引号里面的内容。用一个变量接收函数的返回值，经测试，确实是字符串类型。

PS：本文代码基于Windows 10，Python 3.10.4。