在Python Docstrings中，`：obj：`做什么？

Question

我一直看到文字字符串的行如下所示：

param : :obj: str

我无法找到:obj:代表或代表的内容的参考。它似乎表示str对象，但我也看到了

param : int

似乎并没有。

感谢。

Answer 1

这不是内置的Python功能。您正在查看的代码的作者正在使用一些外部工具来自动生成文档。它看起来像Sphinx语法，但我不确定。

我假设您在功能和方法的文档字符串中找到了这些内容。正在识别自动文档生成器的参数类型，以正确记录函数/方法签名。

Answer 2

这是Sphinx - 相关语法，用于在标准Python文档中插入指向`str对象的链接。另请参阅Python Documentation (:obj:`str`) vs (str)。