Xcode 5 में अपने कोड के लिए त्वरित सहायता

टिप्पणियों से प्रलेखन लेना सीखा त्वरित मदद:



पहले, आपको ऐपल्डोक (या एनालॉग) स्थापित .docset , संकलन और स्थापित .docset । .docset ; अब बस एक डॉक्यूमेंट्री कमेंट लिखिए और क्विक हेल्प उसे तुरंत देखेगा।
समर्थित सिंटैक्स पर अभी तक कोई आधिकारिक दस्तावेज नहीं है (कम से कम मुझे नहीं मिला है), लेकिन कुछ हैडरडोक और डॉक्सिज़न के बीच उपयोग किया जाता है।

1)

टिप्पणी का पहला पैराग्राफ ऑटो-पूर्ति में उपयोग किया जाता है, त्वरित सहायता में सभी को दिखाई देता है:

 /** Brief description. Brief description continued. Details follow here. */ - (BOOL)doSomethingWithArgument:(NSString *)argument; 

2)

बेशक, मानक टैग @param , @return समर्थित हैं, साथ ही कुछ अन्य, उदाहरण के लिए, @note , @warning , @see , @code :

 /** Brief description. Brief description continued. Details follow here. @note I am a note! @warning Not thread safe! @param argument Some string. @return YES if operation succeeded, otherwise NO. */ - (BOOL)doSomethingWithArgument:(NSString *)argument; 

3)

आप न केवल अलग-अलग तरीकों का दस्तावेज कर सकते हैं, बल्कि पूरे वर्ग को एक संपूर्ण:

 /** Example class to show the new cool XCode 5 feature. Usage example: @code QHExample *example = [QHExample new]; BOOL result = [example doSomethingWithArgument:@"test"]; @endcode */ @interface QHExample : NSObject 

4)

दस्तावेजीकरण के गुण:

 /// Description for exampleProperty. @property (nonatomic) int exampleProperty; 

5)

पदावनत विधियाँ स्वतः निर्धारित की जाती हैं:

 /** This method is deprecated! @see '-anotherMethod' */ - (void)someMethod __attribute__((deprecated("use '-anotherMethod' instead."))); 

6)

कार्य भी समर्थित हैं:

 /** A function that always returns 42. @param fArg Some float argument. @return 42. */ int function_42(float fArg); 

लेकिन मैक्रों, दुर्भाग्य से, नहीं हैं।

7)

वहाँ समर्थन है:

 /** ROUChunkType description. */ enum ROUChunkType { /// Data chunk. ROUChunkTypeData = 0, /// Acknowledgement chunk. ROUCHunkTypeAck = 1 }; 

लेकिन अनुशंसित NS_ENUM और NS_OPTIONS का कोई समर्थन नहीं है।
यानी यदि आप लिखते हैं:

 /** ROUChunkType description. */ typedef NS_ENUM(uint8_t, ROUChunkType){ /// Data chunk. ROUChunkTypeData = 0, /// Acknowledgement chunk. ROUCHunkTypeAck = 1 }; 

फिर त्वरित सहायता और स्वतः पूर्णता में स्थिरांक वर्णन के लिए उपलब्ध होगा, लेकिन ROUChunkType के प्रकार के लिए - नहीं।

8)

संरचना के प्रकारों के लिए, स्थिति बेहतर है: स्वयं के प्रकार के लिए, स्वत: पूर्णता में कोई विवरण नहीं है, लेकिन त्वरित सहायता में फ़ील्ड के लिए दोनों है।

 /** Chunk header description. */ typedef struct { /// Chunk type. enum ROUChunkType type; /// Chunk length. uint16_t length; } ROUChunkHeader; 

9)

लेकिन ब्लॉक प्रकार के लिए प्रलेखन अच्छी तरह से काम करता है:

 /** A block with one argument returning BOOL. @param arg Block's argument. @return YES. */ typedef BOOL (^QHBlock)(id arg); 

10)

इसके अलावा, टिप्पणियों को न केवल इंटरफ़ेस में, बल्कि कार्यान्वयन में भी समर्थित किया जाता है, जिसमें चर भी शामिल हैं:

 - (double)perimeter{ /// The number π, the ratio of a circle's circumference to its diameter. double pi = M_PI; return 2 * pi * self.r; } 

निष्कर्ष

कुल मिलाकर, यह दस्तावेजी टिप्पणी लिखने का एक और कारण बन गया। इसके अलावा, यदि आप कोड स्निपेट का उपयोग करते हैं तो यह बिल्कुल भी समय लेने वाला नहीं है। उदाहरण के लिए, एक विधि का दस्तावेजीकरण करने के लिए, आप एक स्निपेट बना सकते हैं:

 /** <#Brief#> <#Description#> @param <#Name#> <#Info#> @param <#Name#> <#Info#> @return <#Returns#> */ 

और इसे docmethod docmethod पर लटकाएं:

फिर, docmethod टाइप करते docmethod स्वत: पूर्णता स्वचालित रूप से उपयुक्त टेम्पलेट का सुझाव देगा।