这些格式在Twisted的文档字符串中是什么意思？

Question

这些格式在Twisted的文档字符串中是什么意思？

10

在Twisted的源代码中，许多docstrings包含如下格式：L{xxx}、C{xxx}或以'@'开头的行，它们的含义是什么？

例如，在twisted/internet/interfaces.py中：

def registerProducer(producer, streaming):
    """
    Register to receive data from a producer.
    ...
    For L{IPullProducer} providers, C{resumeProducing} will be called once
    each time data is required.
    ...
    @type producer: L{IProducer} provider
    ...
    @return: C{None}
    """

L{IPullProducer}，C{resumeProducing}，@type producer ?

顺便问一下，这些格式是否是标准的Python文档字符串格式？如果是，我应该参考哪里？谢谢:)

- Coaku

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Glyph · Accepted Answer

Twisted使用的文档格式是Epytext，你可以在epydoc.sourceforge.net上找到相关文档。其中，L{}表示链接，C{}表示代码，I{}表示斜体。更多字段请查看epytext文档。

Twisted项目使用pydoctor生成其文档，命令为pydoctor --add-package twisted。要生成到Twisted依赖的其他项目的链接，还需要进行一些额外操作，如果您想为Twisted做出贡献，请参考这个命令。您也可以使用epydoc twisted来生成文档，但是epydoc不知道Zope接口，因此不能自动将类链接到它们实现的接口。

每个版本的生成API文档都会发布在twistedmatrix.com，您可以在那里浏览。