Python 将.py文件作为模块导入时不显示Docstring？

我正在做一个项目，我开始在其他.py文件中编写函数，并将它们导入到main.py。。。我想为导入的整个文件（模块）编写帮助文本，类似于导入库（模块）时的情况，如下所示：

当我尝试在导入的文件顶部编写类似的内容时，docstring不会出现

试一试：

但是得到这个（没有显示文档字符串）：

---

这可能是因为您的docstring格式。尝试使用以下格式：

“用于.py函数文件的有用文档字符串。”

然后，如果VS代码在模块悬停时仍然没有显示docstring，则在保存文件后使用Reload Window命令（即Ctrl+Shift+p并输入“Reload Window”）。您也可以使用pydocstyle过梁。例如，它说“一行docstring应该放在一行引号中”。Python VS代码扩展支持linter。但请确保启用了

python.linting.pydocstyleEnabled

选项，并且pydocstyle是自己安装的。您可以为您的虚拟环境全局或本地安装它。我更喜欢全局安装-

pip安装pydocstyle

。此外，分机还会检查是否安装了所有启用的过梁，以及是否可以帮助安装这些过梁。

Re:Solved 如注释所示，“”和“”都是等效的。这个问题与使用

Ctrl+Shift+P

和“重新加载窗口”建议重新加载窗口有关。

---

导入文件时的docstring不能在更改时直接更新

我真的怀疑是按引号类型或换行符进行的格式设置。Docstrings必须位于作用域的第一个非空白行上。可能是需要重新加载或vscode过于繁琐，但Python通常认为单引号和双引号是等效的，即使在风格上有偏好，例如linters和black。