एक्सकोड कोड प्रलेखन

Question

क्या एक्सकोड में लिखे गए कोड को दस्तावेज़ित करने के बारे में कोई दिशानिर्देश/मानक हैं? मेरा मतलब है, क्या कोड को दस्तावेज करने का कोई तरीका है यदि आप इसे दूसरों के लिए आसानी से समझना चाहते हैं? क्या एक्सकोड एक ऐसा उपकरण प्रदान करता है जिसका उपयोग आपके कोड + टिप्पणियों से एपीआई संदर्भ दस्तावेज़ों जैसे दस्तावेज़ों को स्वचालित रूप से उत्पन्न करने के लिए किया जा सकता है?

कम से कम मुझे समझने में दिलचस्पी है कि आपके कोड में परिभाषित इंटरफेस/प्रोटोकॉल/विधियों से पहले टिप्पणियां लिखने का मानक तरीका है या नहीं। मैं के बाद एक तरह निर्देशों का उपयोग करके देखा है, लेकिन मैं समझ में नहीं आया कि वे कैसे काम करते हैं:

#pragma mark - 
#pragma mark Initialization 

Answer 1

आप एक में उन दो पंक्तियों विलय कर सकते हैं: #pragma mark - Initialization। विधि सूची (ऊपर, दाएं) पर क्लिक करें और आपको एक पंक्ति के साथ एक बोल्ड हेडर दिखाई देगा। यह वर्गों में समूह विधियों के लिए सिर्फ एक मार्कर है।

उपरोक्त डेरेक द्वारा पोस्ट किए गए कोडिंग दिशानिर्देश लिंक को पढ़ना आवश्यक है।

यदि आप ऐप्पल जैसी दस्तावेज तैयार करना चाहते हैं तो आपको इस उत्कृष्ट और मुफ्त तृतीय पक्ष टूल का उपयोग करना होगा: http://www.gentlebytes.com/appledoc/ ऐप्पल आपको इसके करीब कुछ भी प्रदान नहीं करता है।

---

प्रागमा संकलक को संकेत देने के लिए एक आईएसओ सी सुविधा है।

एक्सकोड (AFAIK) में एकमात्र प्रज्ञा जोड़ mark- और/या पाठ के साथ है। यह विधि खोजक में एक रेखा और/या बोल्ड पाठ बनाता है।

// Mark a section in your code with a line and a bold text. 
// You can use the line or the text alone. 
#pragma mark - random text 

आप भाषाओं पर फाइल जो जीसीसी के साथ संकलन नहीं है संपादन कर रहे हैं, तो आप अभी भी निशान टिप्पणियों पर उपयोग कर सकते हैं (यह भी जीसीसी भाषाओं के लिए काम करता है):

// MARK: - random text 
/* MARK: more random text */ 

लेकिन मैं #pragma का उपयोग निशान क्योंकि मेरे रंग विषय में लाल रंग हैं और वे टिप्पणियों से बेहतर खड़े हैं। यदि आप एक pragma कोड स्निपेट एक हॉटकी से आबद्ध चाहते हैं, का उपयोग

#pragma mark - <#Description#> 

ताकि आप विवरण पाठ करने के लिए टैब कूद कर सकते हैं।

अधिक pragmas के बारे में:

• What is a pragma?
• 6.56 Pragmas Accepted by GCC
• बजना के Controlling Diagnostics via Pragmas
• Function attributes pragmas को पसंद किया जाता है क्योंकि आप मैक्रो से pragmas उत्पन्न नहीं कर सकते और एक pragma पर एक अलग अर्थ हो सकता है एक और कंपाइलर।

Answer 2

@ jano के उत्तर में जोड़ना, अपनी विधि की कार्यक्षमता का वर्णन करने के लिए नीचे प्रारूप का उपयोग करें।

/*! 
@function  getEmployeeDetails 
@abstract  getEmployeeDetails 
@discussion  This function will fetch employee details based on employee id 
@param   strEmpId 
employee unique id 
@result   an Array of Employee 
*/ 

-(NSArray*)getEmployeeDetails:(NSString *)strEmpId{ 
    /*Do somethings.*/ 
}