ट्विस्ट के डॉकस्ट्रिंग में इन प्रारूपों का क्या अर्थ है?

Question

ट्विस्ट के स्रोत कोड में, कई दस्तावेज़ों में इस तरह के प्रारूप होते हैं: एल {xxx} या सी {xxx} या एक पंक्ति '@' से शुरू होती है, उनका क्या अर्थ है?

उदाहरण के लिए

, मुड़/इंटरनेट/interfaces.py में:

def registerProducer(producer, streaming): 
    """ 
    Register to receive data from a producer. 
    ... 
    For L{IPullProducer} providers, C{resumeProducing} will be called once 
    each time data is required. 
    ... 
    @type producer: L{IProducer} provider 
    ... 
    @return: C{None} 
    """ 

एल {IPullProducer}, सी {resumeProducing}, @type निर्माता?

वैसे, इन स्वरूपों मानक अजगर docstring स्वरूपों का एक हिस्सा हैं? यदि हां, तो मुझे कहां से संदर्भित करना चाहिए? धन्यवाद :)

Answer 1

प्रलेखन मुड़ द्वारा इस्तेमाल किया प्रारूप Epytext, which is documented on epydoc.sourceforge.net है।

L{} का मतलब है "लिंक" (अर्थात "यह एक अजगर पहचानकर्ता है, इससे जुड़े हों तो कृपया") C{} का अर्थ है "कोड" (यानी hello C{foo} bar "हैलो foo बार" प्रारूप में होना चाहिए)। I{} का मतलब है "इटालिक्स में"। आप epytext दस्तावेज में और फ़ील्ड देख सकते हैं।

ट्विस्टेड प्रोजेक्ट pydoctor के साथ अपने दस्तावेज़ को pydoctor --add-package twisted जैसे आमंत्रण का उपयोग करके उत्पन्न करता है। इसमें कुछ और परियोजनाएं हैं जो ट्विस्टेड पर निर्भर कुछ अन्य परियोजनाओं के लिंक उत्पन्न करने के लिए हैं, लेकिन अगर आप ट्विस्टेड में डॉकस्ट्रिंग का योगदान करना चाहते हैं तो आप इसका विचार प्राप्त कर सकते हैं। आप epydoc twisted का उपयोग करके, epydoc के साथ दस्तावेज़ भी उत्पन्न कर सकते हैं, लेकिन epydoc को ज़ोप इंटरफ़ेस के बारे में पता नहीं है और इसलिए वे स्वचालित रूप से उन इंटरफेस को कक्षाओं से लिंक नहीं करेंगे जो वे लागू करते हैं।

The generated API documentation for each release is published on twistedmatrix.com, और आप इसे वहाँ ब्राउज़ कर सकते हैं।