कोटलिन केडीओसी

Question

में @ लिंक और @ कोड का उपयोग कैसे करें मैं @link और @codeJavaDoc में उपयोग करने की कोशिश कर रहा हूं और एक विधि दस्तावेज करने की कोशिश कर रहा हूं।

मुझे पता है कि कोटलिन में kDoc है लेकिन मुझे उन्हें कम से कम कुछ नहीं मिल रहा है।

Answer 1

@link और @code केडीओसी में मौजूद नहीं है लेकिन आसानी से Inline Markup द्वारा प्रतिस्थापित किया जा सकता है।

KotlinDoc Linking to Elements

इनलाइन मार्कअप

इनलाइन मार्कअप के लिए से

, KDoc नियमित Markdown वाक्य रचना, समर्थन कोड में अन्य तत्वों को जोड़ने के लिए एक आशुलिपि वाक्य रचना के लिए बढ़ा दिया उपयोग करता है।

इस उद्देश्य के लिए विधि [foo] उपयोग:

तत्वों

से लिंक करना एक और तत्व (वर्ग, विधि, संपत्ति या पैरामीटर) से लिंक करने के लिए, बस वर्ग कोष्ठक में इसका नाम डाल दिया। इस उद्देश्य के लिए

उपयोग [this method][foo]:

आप लिंक के लिए एक कस्टम लेबल निर्दिष्ट करना चाहते हैं, Markdown संदर्भ शैली सिंटैक्स का उपयोग करें। आप लिंक में योग्य नामों का भी उपयोग कर सकते हैं। ध्यान दें कि, जावाडोक के विपरीत, योग्य नाम हमेशा डॉट वर्ण का उपयोग घटकों को अलग करने, यहां तक ​​कि एक विधि नाम से पहले:

उपयोग [kotlin.reflect.KClass.properties] वर्ग के गुणों की गणना करने में। लिंक में नाम एक ही नियमों का उपयोग करके हल किए जाते हैं जैसे कि नाम दस्तावेज़ के दस्तावेज़ के अंदर उपयोग किया गया था। विशेष रूप से, यह का अर्थ है कि यदि आपने वर्तमान फ़ाइल में कोई नाम आयात किया है, तो आप को किसी KDoc टिप्पणी में इसका उपयोग करते समय पूरी तरह से योग्यता प्राप्त करने की आवश्यकता नहीं है।

ध्यान दें कि केडीओसी में लिंक में ओवरलोडेड सदस्यों को हल करने के लिए कोई वाक्यविन्यास नहीं है। चूंकि कोटलिन प्रलेखन उत्पादन उपकरण को उसी पृष्ठ पर किसी फ़ंक्शन के सभी ओवरलोड के लिए प्रलेखन देता है, कार्य के लिए लिंक के लिए एक विशिष्ट अधिभारित फ़ंक्शन की पहचान करने की आवश्यकता नहीं है।