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