कई डॉक्सिजन कमांड हैं जिनका उद्देश्य प्रलेखन में लिंक बनाना है (@link, @ref)।
मैं वर्तमान में 0xकमांड का उपयोग कर एक कस्टम फ़ाइल का लिंक बनाने के लिए उपयोग कर रहा हूं, जो डॉक्सिजन (xml) द्वारा समर्थित भाषा में लिखी गई है।
मैं इस लिंक को बदलना चाहता हूं ताकि यह फ़ाइल में एक सटीक रेखा को इंगित करे।
क्या कोई डॉक्सिजन कमांड है जो ऐसा करने की अनुमति देता है?डॉक्सिजन दस्तावेज में फ़ाइल की एक विशिष्ट पंक्ति के लिए लिंक बनाने के लिए
मुझे यकीन नहीं है कि \ref या \link ऐसा कर सकता है। हालांकि, अगर वे कर सकते हैं, तो इस दृष्टिकोण को अपनाने की एक समस्या यह है कि यदि आप लिंक को बदले बिना लिंक की गई सामग्री की सामग्री बदलते हैं तो लिंक अमान्य हो जाएंगे। यह स्रोत कोड और दस्तावेज को अलग करने की समस्याओं में से एक है।
किसी अन्य फ़ाइल में किसी विशेष पंक्ति से जोड़ने की बजाय आप दस्तावेज़ में रुचि रखने वाली फ़ाइल का विशेष भाग क्यों शामिल नहीं करते?
\include साथ पूरी फ़ाइल में शामिल हैं (वहाँ भी \includelineno है) और केवल पाठ में यह के प्रासंगिक भागों संदर्भ (जैसे "समारोह नीचे कोड में xxx"), या\snippet का उपयोग करके दस्तावेज़ीकरण में उन्हें संदर्भित करने की आवश्यकता है।संपादित: वैकल्पिक रूप से, आप \dontinclude आदेश जो, एक साथ के साथ \line, \skip, \skipline, और \until आदेशों आप विशिष्ट लाइनों/एक विशेष फ़ाइल के ब्लॉक शामिल करने के लिए अनुमति देता है इस्तेमाल कर सकते हैं। \dontinclude दस्तावेज़ीकरण में उदाहरण देखें।
आपके सुझावों के लिए धन्यवाद। '\ Snippet' कमांड प्रतीत होता था, हालांकि यह केवल _source files_ से कोड स्निपेट के लिए काम करता है, जबकि मैं अपने _xml संसाधन फ़ाइल_ से डेटा दिखाना चाहता हूं। मैं स्निपेट स्थान को मेरी एक्सएमएल फ़ाइल में पहचानने वाले टैग नहीं जोड़ सकता क्योंकि डॉक्सिजन-शैली की टिप्पणियां इसे "तोड़ देंगी"। \ शामिल का उपयोग स्मार्ट भी है, लेकिन यह एक बड़ी फाइल है और मैं इसे हर बार शामिल नहीं करना चाहता (दस्तावेज अप्रासंगिक डेटा द्वारा छोड़ा जाएगा)। हालांकि जब मैं अपनी फाइल को \ ref का उपयोग करता हूं, तो आप सुझाव देते हैं कि मैं प्रासंगिक भागों का संदर्भ लेता हूं। मैं बस एक बेहतर तरीका ढूंढ रहा हूं। – wil
@wil कोई समस्या नहीं है। मैंने '\ dontinclude' कमांड पर एक नोट भी जोड़ा है, जो आपके लिए \ \ snippet' कमांड से बेहतर होगा क्योंकि इसे किसी भी टैग को आपकी संसाधन फ़ाइल में जोड़ने की आवश्यकता नहीं है। हालांकि, प्रलेखन के अनुसार ऐसा लगता है कि यह आदेश केवल स्रोत फ़ाइलों पर काम करता है (मैंने इसका परीक्षण नहीं किया है, इसलिए मुझे यकीन नहीं है कि यह वास्तव में मामला है)। आप सीधे अपने दस्तावेज़ में एक्सएमएल भी शामिल कर सकते हैं। यह विफल होने पर मुझे डर है कि आपको बस अपनी '\ ref' विधि का उपयोग करके रहना होगा। – Chris
मैंने '\ dontinclude' आदेशों को आजमाया और यह xml फ़ाइलों के लिए भी काम करता है! मैंने इस समाधान के लिए निपटाया है और अपना उत्तर "स्वीकृत" के रूप में सेट किया है :-) – wil