python pydoc命令

Python自带的pydoc模块，可以非常方便地查看、生成帮助文档，该文档是HTML格式的，因此查看、使用起来非常方便。

python pydoc命令作用

（1）生成文本格式的注释文档

import pydoc
import sys
with open('aa.txt', 'w') as f:
pydoc.doc('bin.socketServer', output=f)

（2）使用help()函数, 生成的是文本格式的文档

import pydoc
import sys
# help() == pydoc.help() == pydoc.doc()  
sys.stdout = open('aa.txt', 'w')
help('bin.socketServer')
sys.stdout.close()
#  sys.stdout的作用是将输出到控制台的内容写
# 入文件
# 问题1：help函数会生成每一个类所有父类的注释文档， 所有公共父类会重复生成很多次注释，

启动python pydoc命令方法

pydoc启动服务器和浏览器的方法为，在console中输入命令：

python -m pydoc -b

上述命令的m参数表示：查看module在当前的可见的搜索路径上；b表示启动的是浏览器。

在我的Anoconda中python3.4环境下使用上述命令。

以上就是python pydoc的基本介绍，在查看和生成文档方面，我们很多时候都是需要依赖pydoc模块的使用。

（推荐操作系统：windows7系统、Python 3.9.1，DELL G3电脑。）