冒号包装类在python注释中是什么意思

Question

冒号包装类(:class:(在python注释中是什么意思？

例如，

class Optimizer(object):
r"""Base class for all optimizers.
Arguments:
params (iterable): an iterable of :class:`torch.Tensor` s or
:class:`dict` s. Specifies what Tensors should be optimized.
defaults: (dict): a dict containing default values of optimization
options (used when a parameter group doesn't specify them).
"""
def __init__(self, params, defaults):
self.defaults = defaults

它是pytorch特定的语法，还是什么？

来源：https://github.com/pytorch/pytorch/blob/master/torch/optim/optimizer.py

Answer 1

它与Python或Torch无关。它是文档工具的语法；很可能是狮身人面像。

语法表示对另一个类的文档的交叉引用。当文档工具生成超链接输出(如HTML(时，这些引用会自动成为指向命名类的文档页面的链接。

对于Sphinx，请参阅交叉引用语法文档；在那里，您会看到py:class:作为类引用，但我们可以假设默认域设置为Python，因此:class:也是有效的。

PyTorch项目确实使用了狮身人面像来生成文档。您可以将找到的来源与生成的文档进行比较；注意dict和torch.Tensor都是指向更多文档的超链接。