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

Question

我正在开发一个项目，我开始在其他 .py 文件中编写函数并将它们导入到主 .py...我想为我正在导入的整个文件（模块）编写帮助文本，类似于当像这样导入库（模块）时：

当我尝试在导入的文件顶部编写类似的内容时，文档字符串不会显示。

尝试这个：

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

Answer 1

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

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

然后，如果模块悬停时 VS Code 仍然不显示文档字符串，请在保存文件后使用 Reload Window 命令（即

Ctrl+Shift+P

并输入“重新加载窗口”）。您也可以使用 pydocstyle linter。例如，它说“一行文档字符串应该放在带有引号的一行上”。 linter 由 Python VS Code 扩展支持。但请确保，

python.linting.pydocstyleEnabled

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

pip install pydocstyle

。该扩展还会检查是否安装了所有启用的 linter，并可以帮助安装它们。

Answer 2

回复：已解决

正如评论中所建议的，“ ”和“”是等效的。该问题与按照

Ctrl+Shift+P

和“重新加载窗口”的建议重新加载窗口有关。 导入文件的文档字符串在更改时不得直接更新

Answer 3

我又遇到了一个案例。

如果您在

help="text"

内添加

command()

，则 y

也就是说，

@click.command(help="My cool utility")
@click.argument("fizz", required=True)
@click.argument("buzz", required=True)
def utility(fizz: str, buzz: str):
    """This utility is amazing"""

那么当您执行 --help 时，您的文档字符串

不会

显示。

删除

help="My cool utility"

就可以了。