一日一技：Python自帶的文檔生成模塊

一日一技：Python自帶的文檔生成模塊

圖片攝影：產品經理

廚師：kingname

若是咱們的註釋寫的足夠規範，Python可以自動爲咱們生成很是好看的文檔。

生成文檔的模塊叫作 pydoc，當咱們安裝完成Python之後，它就會被自動添加進環境變量裏面。

爲了演示 pydoc的使用方法，咱們先建立兩個.py文件，以下面兩張圖所示：

代碼裏面的註釋已經解釋了每一個模塊的功能，可是註釋和代碼混着畢竟看起來不方便，因此咱們能夠使用 pydoc來把註釋生成文檔。

在終端裏面進入代碼所在的文件夾，運行以下代碼：

python3 -m pydoc SuperSpider

運行效果以下圖所示：

文檔和Linux的 man生成的文檔別無二致。而且能夠經過鍵盤上的 j或方向鍵下往下滾動屏幕，或者鍵盤上的 k或者方向鍵上往上滾動屏幕。

若是你以爲在命令行下面依然不方便，那麼還能夠自動生成一個HTTP服務。在當前文件夾下面執行命令：

python3 -m pydoc -p 8877

其中的 8877是端口號，你能夠改爲任何一個沒有被佔用的端口。

此時界面以下圖所示：

在瀏覽器中打開：127.0.0.1:8877，能夠看到以下頁面：

其中箭頭所指的地方就是你的模塊。點進去就能看到代碼文檔了：

只要你按照PEP8的規範來寫註釋，那麼這些註釋都能經過pydoc直接轉換爲文檔。