如何在 Python 文档字符串中添加链接？

Question

我在 python 3.x 中有一个函数

def foo():
"""Lorem ipsum for more info, see here""

我想添加一个指向“这里”的超链接以指向一个网站。 在不安装外部插件的情况下如何做到这一点？

Answer 1

只需将链接作为字符串添加到文档字符串中，如下所示：

def foo():
    """Lorem ipsum for more info, see here: www.myfancydocu.com""

docstring 只是一个字符串，所以没有超链接。 但是任何想查看该网站的人都可以复制链接。

有自动文档构建器可以根据您的代码和文档字符串（例如 html）构建文档。 这些可能会使用特定语法向文档添加超链接，但该语法取决于您使用的文档构建器。 如果您只有代码，那么只需将 url 添加为字符串即可。