Python基礎（2）：__doc__、文檔字串docString、help()

標籤：通過   help   tar   返回   targe   應該   python   strong   編譯   

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種方式

 

Python基礎（2）：__doc__、文檔字串docString、help()