Python documentation Twisted

Question

Dans la documentation Twisted quand j'ouvre tout code de Twisted je remarque des choses comme

@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. 

Quelqu'un pourrait-il s'il vous plaît me dire ce que les lettres C, L comme moyen C {de bool}, L {IReactorCore} et qu'est-ce que @see, @ivar, @type signifie?

Answer 1

Il est Epydoc markup:

C{...}: code source ou un identifiant Python.

La construction de balisage en ligne L{text<object>} est utilisé pour créer des liens vers la documentation pour les autres objets Python. text est le texte qui doit être affiché pour le lien, et object est le nom de l'objet Python auquel il devrait être lié. Si vous souhaitez utiliser le nom de l'objet Python comme texte pour le lien, vous pouvez simplement écrire L{object}``.

Le fields (@…) utilisé par Twisted are listed in its documentation generator qui dépend de Epydoc, pydoctor:

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