python - 在 Python 文档字符串中, `:obj:` 有什么作用?

标签 python docstring

我一直看到文档字符串中有这样的行:

param : :obj: str

我找不到对 :obj: 代表什么或做什么的引用。它似乎表示一个 str 对象,但我也看到了

参数:整数

这似乎不合时宜。

谢谢。

最佳答案

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

关于python - 在 Python 文档字符串中, `:obj:` 有什么作用?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41127200/

相关文章:

python - 获取 'str' 到 Django forms.FileField()

python - pySpark forEachPartition - 代码在哪里执行

python - 我收到 __init__() 与 CreateView 获得意外的关键字参数 'instance'

javascript - python 是否具有与 javascript 等效的函数注释?

python - 知道函数不接受来自文档字符串的命名参数

python - 如何使用 python selenium 点击第一个谷歌搜索结果?

python - 如何在 python 中比较两个句子字符串的相似性?

python - 在 PyDev 中查看函数文档字符串的热键?

python-sphinx - 你是否应该始终记录函数,即使是多余的(特别是 python)?

Python 文档字符串意外地没有