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无关。它是文档工具的语法；最有可能是Sphinx。

该语法指示另一个类的文档的交叉引用。当文档工具生成超链接输出（例如HTML）时，此类引用将自动成为指向指定类的文档页面的链接。

对于Sphinx，请参见Cross-referencing syntax documentation；在那里，您会看到py:class:作为类引用，但是我们可以假定默认域设置为Python，因此:class:也有效。

PyTorch项目确实为uses Sphinx to generate the documenation。您可以将找到的来源与the resulting generated documenation进行比较；请注意dict和torch.Tensor都是到更多文档的超链接。

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

1 个答案: