这些格式在twisted的docstring中是什么意思？

Question

在twisted的源代码中，许多docstring包含这样的格式：L{xxx}或C{xxx}或以“@”开头的行，它们的含义是什么？在

例如，在twisted/internet中/接口.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{resumeproducting}，@type producer？

顺便问一下，这些格式是标准python docstring格式的一部分吗？如果是的话，我应该去哪里？谢谢：）

Answer 1

Twisted使用的文档格式是Epytext, which is documented on ^{}。在

L{}表示“link”（即“这是一个Python标识符，请链接到它”）C{}表示“代码”（即hello C{foo} bar的格式应类似于“hellofoobar”）。I{}只是“斜体”的意思。您可以在epytext文档中看到更多字段。在

Twisted项目使用pydoctor生成文档，使用类似pydoctor add-package twisted的调用。它还有一点，生成指向Twisted所依赖的几个其他项目的链接，但是如果您想为Twisted贡献docstring，可以使用它来获得一个想法。您也可以使用epydoc twisted生成epydoc本身的文档，但是epydoc不知道Zope接口，因此不会自动将类链接到它们实现的接口。在

The generated API documentation for each release is published on twistedmatrix.com，你可以在那里浏览。在