Python基础：__doc__文档字符串docStringhelp()

Posted 2020-11-03 `三一三`

OS：Windows 10家庭中文版，Python：3.6.4

 

Python中的 文档字符串（docString） 出现在 模块、函数、类 的第一行，用于对这些程序进行说明。它在执行的时候被忽略，但会

被编译器存放到 模块、函数、类 的__doc__属性中。不过，并非每一个模块、函数、类都有文档字符串。

 

Part 1.自定义模块、函数、类的文档字符串

新建模块dstest.py，存放于Python安装目录下（可以在import模块时被找到）；

导入dstest，查看模块dstest及其下的函数docfunc、类docclass的文档字符串；

 

help()函数用于获取模块、函数、类的帮助信息，这些帮助信息包含了各自的文档字符串信息，下面，看看使用

help()函数获取了什么信息——更多的信息。

-获取模块dstest的帮助信息——里面包含了其下函数、类的帮助信息

-获取函数的帮助信息

-获取类的信息

 

Part 2.内置模块、函数、类的文档字符串 调查

以模块sys为例。

1.直接获取__doc__信息

很杂乱，没法看！因为是Windows平台的命令行吗？\\n没有被解析成回车！

2.使用print函数打印__doc__信息

解析了\\n为回车字符，比直接输出__doc__工整多了。

3.使用help(sys)函数获取帮助信息

视觉效果极佳的帮助信息，就应该用这个！

 

以django为例，演示没有docString的模块：作者-Ben.Z

使用__doc__返回的内容为空（None），但通过help(django)还是可以获得帮助信息的。

 

参考链接：

Python 3.6.5 documentation （里面有全部你需要的Python资料，还可以选择Python版本）

Python获取帮助的3种方式