Python Twisted文档

Question

在Twisted文档中，当我打开任何Twisted代码时，我会注意到

之类的内容

@see: L{IReactorCore<twisted.internet.interfaces.IReactorCore>}
@ivar called: A flag which is C{False} until either C{callback} or
    C{errback} is called and afterwards always C{True}.
@type called: C{bool}

Compute the allowed methods on a C{Resource} based on defined render_FOO
methods. Used when raising C{UnsupportedMethod} but C{Resource} does
not define C{allowedMethods} attribute.

有谁能告诉我字母C，L是什么样的C {bool}，L {IReactorCore}意味着@see，@ ivar，@ type是什么意思？

Answer 1

这是Epydoc markup：

  

C{...}：源代码或Python标识符。

  

内联标记构造L{text<object>}用于创建指向其他Python对象的文档的链接。 text是应该为链接显示的文本，object是应该链接到的Python对象的名称。如果您希望使用Python对象的名称作为链接的文本，您只需编写L{object}``。

Twisted fields使用的are listed in its documentation generator（@…）取决于Epydoc，pydoctor：

@author
@cvar
@ivar
@note
@param (synonym: @arg)
@raise (synonym: @raises)
@return (synonym: @returns)
@rtype (synonym: @returntype)
@see (synonym: @seealso)
@type
@var