pydoc是python自帶的一個文檔生成工具，使用pydoc可以很方便的查看類和方法結構
本文主要介紹：1.查看文檔的方法、2.html文檔說明、
一、查看文檔的方法
方法1：啟動本地服務，在web上查看文檔
命令【python3 -m pydoc -p 1234】
通過http://localhost:1234來訪問查看文檔
說明：
1、-p指定啟動的服務的端口號，可以隨意指定不沖突的端口號
2、只有在自建的工程根目錄下使用該命令，才能看到當前工程下所有的內容，否則只能看到python環境變量下的模塊內容
3、如果本地只有一個python，可以直接使用【pydoc -p 端口號】啟動，但因為我本地有python2和python3，所以指定了用python3
方法2：直接查看某個py文件的內容
上面命令中的 -m 是 python 命令的一個選項，表示運行指定模塊，此處表示運行 pydoc 模塊。后面的“模塊名”參數代表程序要查
例子：新建了一個py文件叫做testpydoc.py，進入testpydoc.py所在目錄
python3 -m pydoc testpydoc
python -m pydoc 模塊名
使用 pydoc 在控制台中查看文檔時，由於一屏無法顯示所有的文檔信息，因此同樣需要以分屏的形式來顯示，這樣查看其實並不方便，與使用 help() 命令查看幫助信息的差別並不大。
當然，在使用 pydoc 查看幫助信息時，它會有自己的組織方式，它總是按如下順序來顯示模塊中的全部內容：
- 模塊的文檔說明：就是＊.py 文件頂部的注釋信息，這部分信息會被提取成模塊的文檔說明。
- CLASSES 部分：這部分會列出該模塊所包含的全部類。
- FUNCTIONS 部分：這部分會列出該模塊所包含的全部函數。
- DATA 部分：這部分會列出該模塊所包含的全部成員變量。
- FILE 部分：這部分會顯示該模塊對應的源文件。
不管怎么樣，直接在控制台中查看指定模塊的幫助信息依然不太方便，下面將會使用 pydoc 來為指定模塊生成 HTML 文檔。
pydoc生成HTML文檔
使用 pydoc 模塊在控制台中查看幫助文檔的命令如下：
python -m pydoc -w 模塊名
上面命令主要就是為 pydoc 模塊額外指定了 -w 選項，該選項代表 write，表明輸出 HTML 文檔。
例如，在 testpydoc.py 所在當前目錄下運行如下命令（未進入到文件所在目錄將出現提示找不到文件，如下）：
No Python documentation found for 'zol_req03'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
#未進入到文件所在目錄將出現提示找不到文件 需要cd到對應目錄下
python -m pydoc -w testpydoc
運行上面命令，可以看到系統生成“wrote testpydoc.html” 提示信息。接下來可以在該目錄下發現額外生成了一個 testpydoc.html 文件，使用瀏覽器打開該文件