Python 扭曲的文档

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{...}: Source code or a Python identifier.

The inline markup construct L{text<object>} is used to create links to the documentation for other Python objects. text is the text that should be displayed for the link, and object is the name of the Python object that should be linked to. If you wish to use the name of the Python object as the text for the link, you can simply write L{object}``.

依赖epydoc、pydoctor的fields (@…) used by Twisted are listed in its documentation generator:

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

Python 扭曲的文档

Python Twisted documentation

python

twisted