將.py文件作為模塊導入時沒有顯示文檔字符串？

Question

我正在做一個項目，我開始在 other.py 文件中編寫函數並將它們導入到 main.py... 我想為我正在導入的整個文件（模塊）編寫幫助文本，類似於何時像這樣導入庫（模塊）：

當我嘗試在要導入的文件頂部編寫類似的內容時，文檔字符串不會顯示。

試試這個：

但是得到這個（沒有顯示文檔字符串）：

Answer 1

這可能是因為您的文檔字符串格式。 嘗試使用這樣的格式：

"""Helpful docstring for a .py file of functions."""

然后，如果 VS Code 在模塊懸停時仍然不顯示文檔字符串，請在保存文件后使用Reload Window命令（即Ctrl+Shift+P並輸入“重新加載窗口”）。 你也可以使用pydocstyle linter 。 例如，它說“單行文檔字符串應該適合帶引號的一行”。 Python VS 代碼擴展支持 linter。 但可以肯定的是， python.linting.pydocstyleEnabled選項已啟用，並且pydocstyle已自行安裝。 您可以為您的虛擬環境全局或本地安裝它。 我更喜歡全局安裝 - pip install pydocstyle 。 擴展程序還檢查是否安裝了所有啟用的 linter 並可以幫助安裝它們。

Answer 2

解決

正如評論中所建議的那樣，“”和“”都是等價的。 問題與使用Ctrl+Shift+P和“重新加載窗口”的建議重新加載 window 有關。 導入文件的文檔字符串在更改時不得直接更新