在Python文档字符串中，`:obj:`do是什么？

我一直看到docstring中有这样的行：

param:：obj:str

我找不到

：obj:

代表什么或做什么的参考。它似乎表示一个

str

对象，但我也看到了

param:int

这似乎不符合事实

---

谢谢。

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

---

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

这是在标准Python文档中插入指向`str对象的链接的相关语法。另请参见。

您能否在上下文中复制或链接一些示例？例如，请参见此处示例：

param2（：obj:`int`，可选）`param2`的说明像这样的docstring需要注意的一点是，没有真正的“标准”来格式化它们。Sphinx使用基于RST的语法，而Google有一个Python风格的指南，使用不同的语法。但是，你可以把任何对你和你的用户有用的东西放在文档字符串中……它们是为人类制造的，我们只对它们实施标准，以帮助生成漂亮的文档。