将 .py 文件作为模块导入时没有显示文档字符串？
Docstring not showing up when importing .py file as a module?
我正在做一个项目，我开始在其他 .py 文件中编写函数并将它们导入主 .py...我想为我所在的整个文件（模块）编写帮助文本导入，类似于导入这样的库（模块）：
当我尝试在要导入的文件顶部写类似的内容时，文档字符串没有显示。
试试这个：
但是得到这个（没有显示文档字符串）：
这可能是因为您的文档字符串格式。尝试使用这样的格式：
"""Helpful docstring for a .py file of functions."""
然后，如果 VS Code 在模块悬停时仍然没有显示文档字符串，请在保存文件后使用 Reload Window 命令（即 Ctrl+Shift+P 并输入 'reload window')。您也可以使用 pydocstyle linter。例如，它说“一行文档字符串应该放在带引号的一行上”。 Python VS 代码扩展支持 linter。但请确保 python.linting.pydocstyleEnabled 选项已启用并且 pydocstyle 已自行安装。您可以为您的虚拟环境全局或本地安装它。我更喜欢全局安装 - pip install pydocstyle。扩展程序还会检查是否已安装所有已启用的 linters 并可以帮助安装它们。
回复：已解决
正如评论中所建议的那样，“ ”和“ ”是等价的。问题与按照 Ctrl+Shift+P 和 'reload window' 的建议重新加载 window 有关。
导入文件的文档字符串在更改时不得直接更新
我正在做一个项目，我开始在其他 .py 文件中编写函数并将它们导入主 .py...我想为我所在的整个文件（模块）编写帮助文本导入，类似于导入这样的库（模块）：
当我尝试在要导入的文件顶部写类似的内容时，文档字符串没有显示。
试试这个：
但是得到这个（没有显示文档字符串）：
这可能是因为您的文档字符串格式。尝试使用这样的格式：
"""Helpful docstring for a .py file of functions."""
然后，如果 VS Code 在模块悬停时仍然没有显示文档字符串，请在保存文件后使用 Reload Window 命令（即 Ctrl+Shift+P 并输入 'reload window')。您也可以使用 pydocstyle linter。例如，它说“一行文档字符串应该放在带引号的一行上”。 Python VS 代码扩展支持 linter。但请确保 python.linting.pydocstyleEnabled 选项已启用并且 pydocstyle 已自行安装。您可以为您的虚拟环境全局或本地安装它。我更喜欢全局安装 - pip install pydocstyle。扩展程序还会检查是否已安装所有已启用的 linters 并可以帮助安装它们。
回复：已解决
正如评论中所建议的那样，“ ”和“ ”是等价的。问题与按照 Ctrl+Shift+P 和 'reload window' 的建议重新加载 window 有关。