स्विफ्ट कोड दस्तावेज़ करने के सर्वोत्तम तरीके पर कुछ शोध करने के बाद, जैज़ी तेजी से प्रलेखन उत्पन्न करने के लिए अपेक्षित काम नहीं कर रहा है। मैं जाज़ी में आया और इसे लागू करना कितना आसान था। तो मैं Jazzy Documentation के स्थापना खंड का पालन करता हूं। मैंस्विफ्ट दस्तावेज
sudo gem install jazzy
चलाने तब मैं टर्मिनल में अपने प्रोजेक्ट की जड़ पर जाएँ, और jazzy जो एक फ़ोल्डर एक वेबसाइट है कि 1 वर्ग के लिए दस्तावेज़ को प्रदर्शित करता है के साथ "डॉक्स" कहा जाता है बनाता है चलाते हैं। मेरे पास 87 कक्षाएं हैं जिन्हें मैं स्पष्ट रूप से टर्मिनल आउटपुट में जाजी लूपिंग देख सकता हूं।
मैं कोड जो भी Markup Formatting Reference के साथ ही Jazzy Documentation करने के लिए आप लिंक का दस्तावेजीकरण के बारे में NSHipster Tutorial पढ़ा है। मैं कुछ कोड है, जो Xcode सही ढंग से पक्ष फलक में या सही समारोह या वर्ग पर क्लिक प्रदर्शित करता है प्रलेखित है। तो मैं काफी हद तक निश्चित हूं कि मेरा वाक्यविन्यास सही है।
मैंने उस फ़ाइल को दूसरी फ़ाइल में तुलना करने के लिए कुछ समय लगाया जो प्रदर्शित नहीं हो रहा है और मुझे प्रारूप के संबंध में सामान्य से कुछ भी नहीं दिख रहा है।
मैं चल रहा हूँ:
- जाज संस्करण: 0.3.2
- Xcode संस्करण: 7.1
- स्विफ्ट संस्करण: 2.1
- ओएस एक्स एल कैप्टन संस्करण: 10,11
मेरा समग्र सवाल है; क्यों जाज सभी वर्गों के लिए प्रलेखन नहीं उत्पादन है और मैं इस मुद्दे को कैसे ठीक कर सकते हैं?
ऊ धन्यवाद, मैं नाराज था कि यह कैसे 68% दस्तावेज की तरह कहा –
और वहाँ सभी एसीएल दस्तावेज़ के लिए एक रास्ता है (सार्वजनिक, निजी, आंतरिक?) अगर मैं '--min-एसीएल का उपयोग internal' मैं देख रहा हूँ सार्वजनिक तरीकों दर्ज किया गया नहीं है। –
कक्षा के शीर्ष पर एक दस्तावेज़ जोड़ें और यह काम करेगा –