एक्सकोड चर और एक्सकोड में विधियों के लिए दस्तावेज़ कैसे बनाएं?

Question

मैं अपने द्वारा बनाए गए प्रोग्राम के हिस्से के रूप में Alt-Click एक इंस्टेंस चर (या एक विधि) करने में सक्षम होना चाहता हूं और इसका उद्देश्य क्या है।

तथ्य यह है कि एक्सकोड मुझे कक्षा चर बता रहा है - अच्छा है लेकिन पर्याप्त नहीं है। इस मामले में मैं यह लिखने के लिए टाइप किया गया कस्टम टेक्स्ट देखना चाहता हूं कि asset वास्तव में क्या है। इसके अतिरिक्त ivar के प्रकार भी जानना उपयोगी होगा।

यह कैसे किया जा सकता है? इस मामले में, मैं आश्चर्य वास्तव में क्या था मैं द्वारा assets

मतलब मैं विशेष रूप से आश्चर्य है कि अगर इस जानकारी Xcode, समान अंदर से कैसे EclipseJavaDoc सामग्री से पता चलता करने के लिए देखी जा सकती है।

Answer 1

आप अपनी परियोजना के लिए एक दस्तावेज के सेट बनाने और Xcode में इसे स्थापित करने की आवश्यकता होगी। appledoc इससे आपकी सहायता कर सकता है। यह एक कमांड लाइन उपकरण है जो आपके शीर्षकों में विशेष रूप से स्वरूपित टिप्पणियों से ऐप्पल की शैली में दस्तावेज़ उत्पन्न कर सकता है। आप इसे अपनी बिल्ड प्रक्रिया में एक रन स्क्रिप्ट बिल्ड चरण के साथ एकीकृत भी कर सकते हैं, ताकि दस्तावेज़ हमेशा अद्यतित हो।

छोटी परियोजनाओं के लिए, आमतौर पर यह प्रयास के लायक नहीं है और आप शायद अपने हेडर फ़ाइलों पर टिप्पणियां जोड़ने और सीएमडी-क्लिक (Ctrl + Cmd + left-arrow) पर वहां जाने के लिए बेहतर तरीके से कूद रहे हैं, जहां आप वापस जाएं से आया)।

Answer 2

शायद आप Documentation Sets पर ऐप्पल के दस्तावेज़ों के साथ-साथ उनके लेख generating doc sets using Doxygen पर भी देखना चाहते हैं। उत्तरार्द्ध Xcode 3.x पर आधारित है, तो यह कितना प्रासंगिक है कुछ हद तक संदिग्ध है, लेकिन फिर भी एक नज़र रखना एक अच्छा विचार होगा।

यह कहा गया है कि, यदि आप डॉक्सिजन का उपयोग करने का निर्णय लेते हैं (हेडरडॉक जैसे विकल्प दस्तावेज़ीकरण के लिए उपयोग किए जा सकते हैं, लेकिन मुझे यकीन नहीं है कि दस्तावेज़ सेट बनाने के लिए आपके लिए क्या उपलब्ध है), ऐसा लगता है कि मुख्य बिंदु है 0xको अपने डॉक्सफाइल (या जिसे आप इसे कॉल करने का निर्णय लेते हैं) में फेंकना चाहते हैं। उसके बाद, आप परिणामों को ~/Library/Developer/Shared/Documentation/DocSets (डॉक्सिजन के दस्तावेज़ीकरण के अनुसार) में फेंक देंगे। मुझे नहीं पता कि यह एक्सकोड 4.x में काम करता है - हालांकि यह एक शॉट के लायक है, और इसे वापस सुनना अच्छा लगेगा।

नोट: इनमें से अधिकांश बैरी वार्क द्वारा this answer पर आधारित था। चित्रा क्रेडिट वहां मौजूद है, क्योंकि मुझे इस पर ध्यान देने की परेशानी नहीं होगी क्योंकि यह उनके जवाब के लिए नहीं था।