Ce sont ces balises @ivar @param et @type en python docstring?

L'ampoule projet utilise des tags en docstring, comme la javadoc.

Par exemple de pool.py ligne 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
    """

Ce sont ces balises, l'outil utilise.

OriginalL'auteur Andrea Francia | 2008-12-18

  1. 13

    Balisage d'un outil de documentation, probablement epydoc.

    Oui, elles sont expliquées dans la epydoc.sourceforge.net/manual-fields.html

    OriginalL'auteur S.Lott

  2. 12

    Juste pour le fun je note que le Python standard library est à l'aide de Sphinx/reStructuredText, dont info champ de listes sont similaires.

    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
    """
    Combien de convection pour le langage de programmation! Mauvaise chose.
    Francia: Epydoc est très léger (loin d'être aussi puissant que reStructuredText) et a été développé bien avant reStructuredText a été adopté comme un standard. Ils ont tous les deux une bonne raison d'exister, bien que j'avais recommandons aux utilisateurs d'aller avec reStructuredText de là, vers l'avant.
    Et il y a aussi la légèreté de la notation mentionnées dans la PPE 257, qui ne cible pas des outils, mais de lisibilité.

    OriginalL'auteur cdleary