missing - python 3 docstring example

¿Cuáles son estas etiquetas @ivar @param y @type en python docstring?

Question

El proyecto de ampolla usa algunas etiquetas en docstring, como las de javadoc.

Por ejemplo, de la línea 86 de pool.py :

def start(self, ampChild=None):
"""
Starts the ProcessPool with a given child protocol.
@param ampChild: a L{ampoule.child.AMPChild} subclass.
@type ampChild: L{ampoule.child.AMPChild} subclass
"""

¿Qué son estas etiquetas? ¿Qué herramienta lo usa?

Answer 1

Marcado para una herramienta de documentación, probablemente epydoc .

Answer 2

Solo por diversión, señalaré que la biblioteca estándar de Python está utilizando Sphinx / reStructuredText, cuyas listas de campos de información son similares.

def start(self, ampChild=None):
"""Starts the ProcessPool with a given child protocol.
:param ampChild: a :class:`ampoule.child.AMPChild` subclass.
:type ampChild: :class:`ampoule.child.AMPChild` subclass
"""