python文档字符串中的@ivar@param和@type标记是什么?

python文档字符串中的@ivar@param和@type标记是什么?,python,documentation,javadoc,Python,Documentation,Javadoc,安瓿项目在docstring中使用了一些标签,比如javadoc标签 例如,第86行: 这些标记是什么,哪个工具使用它。可能是文档工具的标记。只是为了好玩,我会注意到Python标准库使用的是Sphinx/reStructuredText,它们类似 def start(self, ampChild=None): """Starts the ProcessPool with a given child protocol. :param ampChild: a :class:`am

安瓿项目在docstring中使用了一些标签,比如javadoc标签

例如,第86行:


这些标记是什么,哪个工具使用它。

可能是文档工具的标记。

只是为了好玩,我会注意到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
    """

同一种编程语言需要多少个对流!坏东西。@Andrea Francia:Epydoc非常轻量级(远不及reStructuredText强大),在reStructuredText被作为标准采用之前就已经开发好了。它们都有很好的理由存在,不过我建议用户从现在开始使用StructuredText。还有PEP 257中提到的轻量级符号,它不是针对工具,而是针对人类可读性。
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
    """