我正在做一個項目，我開始在其他 .py 文件中編寫函數并將它們導入主 .py ...我想為我正在導入的整個文件（模塊）編寫幫助文本，類似于什么時候像這樣導入一個庫（模塊）：當我嘗試在要導入的文件頂部編寫類似內容時，文檔字符串沒有顯示。試試這個：但是得到這個（沒有顯示文檔字符串）：
2 回答
慕田峪7331174
TA貢獻1828條經驗 獲得超13個贊
這可能是因為您的文檔字符串格式。嘗試使用這樣的格式：
"""Helpful docstring for a .py file of functions."""
然后，如果 VS Code 在模塊懸停時仍未顯示文檔字符串，請在保存文件后使用重新加載窗口Ctrl+Shift+P命令（即輸入“重新加載窗口”）。您也可以使用pydocstyle linter。例如，它說“一行文檔字符串應該放在帶引號的一行上”。linter 由Python VS 代碼擴展支持。但可以肯定的是，該python.linting.pydocstyleEnabled選項已啟用并且pydocstyle已自行安裝。您可以為您的虛擬環境全局或本地安裝它。我更喜歡全局安裝 - pip install pydocstyle. 擴展程序還會檢查是否已安裝所有已啟用的 linter，并可以幫助安裝它們。
當年話下
TA貢獻1890條經驗 獲得超9個贊
解決
正如評論中所建議的那樣， ' ' 和 " " 是等價的。問題與按照建議重新加載窗口和“重新加載窗口”有關Ctrl+Shift+P。
導入文件的文檔字符串在更改時不得直接更新
添加回答
舉報
0/150
提交
取消