将 .py 文件作为模块导入时没有显示文档字符串？

Question

我正在做一个项目，我开始在其他 .py 文件中编写函数并将它们导入主 .py ...我想为我正在导入的整个文件（模块）编写帮助文本，类似于什么时候像这样导入一个库（模块）：当我尝试在要导入的文件顶部编写类似内容时，文档字符串没有显示。试试这个：但是得到这个（没有显示文档字符串）：

Answer 1

这可能是因为您的文档字符串格式。尝试使用这样的格式：

"""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，并可以帮助安装它们。

Answer 2

解决

正如评论中所建议的那样， ' ' 和 " " 是等价的。问题与按照建议重新加载窗口和“重新加载窗口”有关Ctrl+Shift+P。

导入文件的文档字符串在更改时不得直接更新