कई डॉक्सिजन कमांड हैं जिनका उद्देश्य प्रलेखन में लिंक बनाना है (@link, @ref)।
मैं वर्तमान में 0xकमांड का उपयोग कर एक कस्टम फ़ाइल का लिंक बनाने के लिए उपयोग कर रहा हूं, जो डॉक्सिजन (xml) द्वारा समर्थित भाषा में लिखी गई है।
मैं इस लिंक को बदलना चाहता हूं ताकि यह फ़ाइल में एक सटीक रेखा को इंगित करे।
क्या कोई डॉक्सिजन कमांड है जो ऐसा करने की अनुमति देता है?डॉक्सिजन दस्तावेज में फ़ाइल की एक विशिष्ट पंक्ति के लिए लिंक बनाने के लिए
7
A
उत्तर
6
मुझे यकीन नहीं है कि \ref
या \link
ऐसा कर सकता है। हालांकि, अगर वे कर सकते हैं, तो इस दृष्टिकोण को अपनाने की एक समस्या यह है कि यदि आप लिंक को बदले बिना लिंक की गई सामग्री की सामग्री बदलते हैं तो लिंक अमान्य हो जाएंगे। यह स्रोत कोड और दस्तावेज को अलग करने की समस्याओं में से एक है।
किसी अन्य फ़ाइल में किसी विशेष पंक्ति से जोड़ने की बजाय आप दस्तावेज़ में रुचि रखने वाली फ़ाइल का विशेष भाग क्यों शामिल नहीं करते?
\include
साथ पूरी फ़ाइल में शामिल हैं (वहाँ भी\includelineno
है) और केवल पाठ में यह के प्रासंगिक भागों संदर्भ (जैसे "समारोह नीचे कोड में xxx"), या- के टुकड़े शामिल हैं: आप या तो कर सकते थे फ़ाइल का जहां आपको
\snippet
का उपयोग करके दस्तावेज़ीकरण में उन्हें संदर्भित करने की आवश्यकता है।
संपादित: वैकल्पिक रूप से, आप \dontinclude
आदेश जो, एक साथ के साथ \line
, \skip
, \skipline
, और \until
आदेशों आप विशिष्ट लाइनों/एक विशेष फ़ाइल के ब्लॉक शामिल करने के लिए अनुमति देता है इस्तेमाल कर सकते हैं। \dontinclude
दस्तावेज़ीकरण में उदाहरण देखें।
संबंधित मुद्दे
- 1. पीडीएफ दस्तावेज बनाने के लिए डॉक्सिजन के लाटेक्स आउटपुट को नियंत्रित करना
- 2. दस्तावेज प्रीप्रोसेसर डॉक्सिजन
- 3. Emacs में बाहरी फ़ाइल लाइन के लिए एक लिंक बनाने के लिए ऑर्ग मोड
- 4. विशिष्ट प्रकार की एक फ़ाइल के लिए आइकन कैसे बदलें?
- 5. अपने Android एप्लिकेशन बनाने के लिए एक और विशिष्ट एप्लिकेशन
- 6. इकाइयों के लिए लिंक: यूनियन + विशिष्ट
- 7. सी कार्यों के लिए कॉल और कॉलर ग्राफ़ बनाने के लिए डॉक्सिजन कैसे प्राप्त करें
- 8. इकाइयों के लिए लिंक विशिष्ट खंड
- 9. इनपुट की एक पंक्ति के लिए QPlainTextEdit
- 10. विशिष्ट डेटा संरचनाओं के निर्माण के लिए बेहतर क्या है: हैशसेट या लिंक की विशिष्ट()?
- 11. लिंक (इकाइयों के लिए)
- 12. रेल में एक नष्ट लिंक बनाने के लिए डिफ़ॉल्ट जावास्क्रिप्ट फ़ाइलों की आवश्यकता क्यों है?
- 13. क्या एक्सकोड 4 प्लगइन बनाने के लिए कोई दस्तावेज है?
- 14. LinqToExcel - एक विशिष्ट पंक्ति
- 15. संपूर्ण टीडी कैसे एक लिंक बनाने के लिए?
- 16. डायरेक्ट लिंक बनाने के लिए "प्रोजेक्ट आईडी" कैसे प्राप्त करें?
- 17. एक विशिष्ट ट्वीट के लिए ट्विटर के लिंक के लिए यूआरएल
- 18. यूट्यूब iframe एम्बेड में विशिष्ट टाइम्स के लिए लिंक
- 19. Mercurial - कोड की एक विशिष्ट पंक्ति के लिए इतिहास को कैसे देखें
- 20. एपीआई दस्तावेज रुपयेपीईसी के लिए?
- 21. डॉक्सिजन से उत्पन्न दस्तावेज में संबंधित फाइल पथ
- 22. डॉक्सिजन दस्तावेज अनुभागों के क्रम को कैसे नियंत्रित करें?
- 23. विशिष्ट फ़ाइल के लिए एआरसी कैसे जोड़ें?
- 24. एक संपूर्ण तालिका पंक्ति को एक लिंक में बनाने के लिए सबसे मानक और संगत तरीका क्या है?
- 25. एक विशिष्ट अद्वितीय डिवाइस के लिए आवेदन
- 26. ऑब्जेक्टिव-सी श्रेणियों को सही तरीके से दस्तावेज करने के लिए डॉक्सिजन को कॉन्फ़िगर कैसे करें
- 27. डॉक्सिजन के लाटेक्स आउटपुट को एक बड़े दस्तावेज़ के लिए परिशिष्ट के रूप में
- 28. फ़ाइल को बनाने और लिखने के लिए
- 29. एक विशिष्ट div के लिए सीएसएस ओवरराइडिंग?
- 30. एक फ़ाइल से दूसरी फ़ाइल में विशिष्ट लाइनों को लिखने के लिए पायथन का उपयोग
आपके सुझावों के लिए धन्यवाद। '\ Snippet' कमांड प्रतीत होता था, हालांकि यह केवल _source files_ से कोड स्निपेट के लिए काम करता है, जबकि मैं अपने _xml संसाधन फ़ाइल_ से डेटा दिखाना चाहता हूं। मैं स्निपेट स्थान को मेरी एक्सएमएल फ़ाइल में पहचानने वाले टैग नहीं जोड़ सकता क्योंकि डॉक्सिजन-शैली की टिप्पणियां इसे "तोड़ देंगी"। \ शामिल का उपयोग स्मार्ट भी है, लेकिन यह एक बड़ी फाइल है और मैं इसे हर बार शामिल नहीं करना चाहता (दस्तावेज अप्रासंगिक डेटा द्वारा छोड़ा जाएगा)। हालांकि जब मैं अपनी फाइल को \ ref का उपयोग करता हूं, तो आप सुझाव देते हैं कि मैं प्रासंगिक भागों का संदर्भ लेता हूं। मैं बस एक बेहतर तरीका ढूंढ रहा हूं। – wil
@wil कोई समस्या नहीं है। मैंने '\ dontinclude' कमांड पर एक नोट भी जोड़ा है, जो आपके लिए \ \ snippet' कमांड से बेहतर होगा क्योंकि इसे किसी भी टैग को आपकी संसाधन फ़ाइल में जोड़ने की आवश्यकता नहीं है। हालांकि, प्रलेखन के अनुसार ऐसा लगता है कि यह आदेश केवल स्रोत फ़ाइलों पर काम करता है (मैंने इसका परीक्षण नहीं किया है, इसलिए मुझे यकीन नहीं है कि यह वास्तव में मामला है)। आप सीधे अपने दस्तावेज़ में एक्सएमएल भी शामिल कर सकते हैं। यह विफल होने पर मुझे डर है कि आपको बस अपनी '\ ref' विधि का उपयोग करके रहना होगा। – Chris
मैंने '\ dontinclude' आदेशों को आजमाया और यह xml फ़ाइलों के लिए भी काम करता है! मैंने इस समाधान के लिए निपटाया है और अपना उत्तर "स्वीकृत" के रूप में सेट किया है :-) – wil