在Python Docstrings中，「：obj：`是做什麼的？

Question

我一直看到的是有這樣寫行文檔字符串：

param : :obj: str

我無法找到一個參考:obj:代表或做什麼。看起來這將意味着一個str對象，但我也看到

param : int

這似乎沒有嘲弄。

感謝。

Answer 1

這不是Python內置的功能。您正在查看的代碼的作者正在使用一些外部工具來自動生成文檔。它看起來像Sphinx語法，但我不確定。

我假設你在函數和方法的docstrings中找到這些。爲自動文檔生成器標識函數/方法簽名的參數類型。

Answer 2

這是Sphinx相關語法，用於在標準Python文檔中插入鏈接到str對象。另請參閱Python Documentation (:obj:`str`) vs (str)。