में पैरामीटर का संदर्भ देना मैं यह सुनिश्चित करने के लिए स्फिंक्स और ऑटोडॉक्स सुविधा का उपयोग करता हूं कि हमारे पास हमारे प्रोजेक्ट में अच्छे दस्तावेज़ हैं।पाइथन डॉकस्ट्रिंग
तो मैं info field lists से परिचित हूं और मैं अपने दस्तावेज़ों में cross-referencing का उपयोग करने से परिचित हूं।
हालांकि, किसी विधि या फ़ंक्शन के लिए डॉकस्ट्रिंग लिखते समय मुझे टेक्स्ट में उनके पैरामीटर को संदर्भित करना उपयोगी लगता है। लेकिन ऐसा करने के लिए एक संरचित तरीका प्रतीत नहीं होता है।
हम कह सकते हैं उदा।
Use ``name`` to set the usernameलेकिन है कि कोई संरचना है, क्या शैली तुम उस के लिए इस्तेमाल किया है और यदि आप शैली बदलने के आप शिकार और सभी गलत शैलियों को मारने के लिए है याद करने के लिए की आवश्यकता है।
: param: एक जानकारी क्षेत्र सूची के बाहर काम नहीं करता है तो आप
Use :param:`name` to set the usernameनहीं लिख सकते हैं मैंने देखा है कुछ परियोजनाओं का उपयोग करें: parm: लेकिन यह है कि दस्तावेज और नहीं करता है नहीं कर रहा है काम नहीं लग रहा है। तो उनके पास कुछ अनुकूलन होना चाहिए
- मैं जेनेरिक_रोल्स का उपयोग कर सकता हूं लेकिन ऐसा लगता है कि मुझे ऐसी समस्या के आसपास काम करना है जो मुझे यकीन है कि दूसरों का सामना करना पड़ा है।
तो उम्मीद है कि मैंने कुछ अंधेरे से स्पष्ट रूप से याद किया है।
ऐसा लगता है कि जेनेरिक_रोल्स पहले से मौजूद है और यह अधिक सही तरीके से कर सकता है। – Dwayne