这些标签@ivar @param和python docstring中的@type是什么?

时间:2008-12-18 21:26:39

标签: python documentation javadoc

安瓿项目在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 个答案:

答案 0 :(得分:14)

文档工具的标记,可能是epydoc

答案 1 :(得分:13)

为了好玩,我会注意到Python标准库使用的是Sphinx / reStructuredText,其info field lists类似。

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