2008-12-18 5 views
13

ampoule प्रोजेक्ट davstring में कुछ टैग का उपयोग करता है, जैसे javadoc वाले।पाइथन डॉकस्ट्रिंग में ये टैग @ivar @param और @type क्या हैं?

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

क्या इन टैग, जो उपकरण का उपयोग करता है इस प्रकार हैं:

उदाहरण के लिए pool.py से लाइन 86।

उत्तर

13

एक प्रलेखन उपकरण के लिए मार्कअप, शायद epydoc

+2

हाँ, वे http://epydoc.sourceforge.net/manual-fields.html –

11

बस मस्ती के लिए मैं ध्यान दूंगा कि पायथन मानक लाइब्रेरी स्फिंक्स/रीस्ट्रक्चरर्ड टेक्स्ट का उपयोग कर रही है, जिसका 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 
    """ 
+4

से वर्णन किया गया कैसे एक ही प्रोग्रामिंग भाषा के लिए कई संवहन! बुरी बात। –

+6

@ एंड्रिया फ्रांसिआ: एपीडोक बहुत हल्का है (कहीं भी पुन: संरचित पाठ के रूप में शक्तिशाली नहीं है) और पुन: संरचित पाठ को मानक के रूप में अपनाया जाने से पहले अच्छी तरह से विकसित किया गया था। दोनों के पास मौजूदा के लिए अच्छा कारण है, हालांकि मैं उपयोगकर्ताओं को यहां से पुन: संरचित पाठ के साथ आगे बढ़ने की सलाह दूंगा। – cdleary

+0

और पीईपी 257 में उल्लिखित हल्के नोटेशन भी हैं, जो उपकरण की ओर लक्षित नहीं हैं, बल्कि मानव पठनीयता। –