Что это за теги @ivar @param и @type в строке документации python?
В проекте ампул используются некоторые теги в 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)
что стандартная библиотека 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
"""
Сколько конвекции для одного и того же языка программирования! Плохо.
Также есть облегченная запись, упомянутая в PEP 257, которая предназначена не для инструментов, а для удобства чтения.
@Andrea Francia: Epydoc очень легок (еще далеко не такой мощный, как reStructuredText) и был разработан задолго до того, как reStructuredText был принят в качестве стандарта. У них обоих есть веские основания для существования, хотя я бы порекомендовал пользователям перейти с reStructuredText с этого момента.