Python Twisted 文档

【问题标题】：Python Twisted documentationPython Twisted 文档
【发布时间】：2017-04-21 06:49:50
【问题描述】：

在 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 like C{bool}、L{IReactorCore} 是什么意思，@see、@ivar、@type 是什么意思？

【问题讨论】：

标签： python twisted

【解决方案1】：

我是Epydoc markup：

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

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

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

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

【讨论】：