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版本)