Что это за теги @ivar @param и @type в строке документации python? - PullRequest
15 голосов
/ 19 декабря 2008

В проекте ампул используются некоторые теги в docstring, например, теги javadoc.

Например, из pool.py строка 86:

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
    """

Что это за теги, какой инструмент его использует.

Ответы [ 2 ]

14 голосов
/ 19 декабря 2008

Разметка для инструмента документации, возможно epydoc .

13 голосов
/ 19 декабря 2008

Ради интереса отмечу, что стандартная библиотека Python использует Sphinx / reStructuredText, чьи списки информационных полей похожи.

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