Xcode 5 में नए दस्तावेज़ कमांड क्या उपलब्ध हैं? [बन्द है]

Question

में से एक Xcode 5 की नई सुविधाओं के लिए एक विशेष टिप्पणी वाक्य-विन्यास के साथ अपने स्वयं कोड दस्तावेज़ के लिए की क्षमता है। प्रारूप doxygen के समान है, लेकिन केवल उन विशेषताओं के सबसेट का समर्थन करता प्रतीत होता है ।

किन आदेशों का समर्थन किया जाता है, और कौन से नहीं हैं?
क्या उनका कोई भी उपयोग doxygen से अलग है?

Answer 1

यहाँ उन सभी विकल्पों का एक उदाहरण है जो मुझे Xcode 5.0.2 के रूप में मिले हैं

इस कोड के साथ जनरेट किया गया था:

/** First line text.

 Putting \\n doesn't create a new line.\n One way to create a newline is by making sure nothing is on that line. Not even a single space character!

 @a Italic text @em with @@a or @@em.

 @b Bold text with @@b.

 @p Typewritter font @c with @@p or @@c.

 Backslashes and must be escaped: C:\\foo.

 And so do @@ signs: user@@example.com

 Some more text.
 @brief brief text
 @attention attention text
 @author author text
 @bug bug text
 @copyright copyright text
 @date date text
 @invariant invariant text
 @note note text
 @post post text
 @pre pre text
 @remarks remarks text
 @sa sa text
 @see see text
 @since since text
 @todo todo text
 @version version text
 @warning warning text

 @result result text
 @return return text
 @returns returns text


 @code
// code text
while (someCondition) {
    NSLog(@"Hello");
    doSomething();
}@endcode
 Last line text.

 @param param param text
 @tparam tparam tparam text
 */
- (void)myMethod {}

टिप्पणियाँ:

• आदेशों एक में होना चाहिए /** block */, /*! block */या के साथ उपसर्ग ///या //!।
• आदेशों के साथ काम @( headerdoc शैली) या \( Doxygen शैली) उपसर्ग। (Ie @bऔर \bदोनों एक ही काम करते हैं।)
• कमांड आमतौर पर उस आइटम से पहले आते हैं जो वे वर्णन कर रहे हैं। (Ie यदि आप एक संपत्ति दस्तावेज़ के लिए कोशिश कर रहे हैं, टिप्पणी से पहले आना चाहिए @propertyपाठ।) वे साथ, बाद में आ सकते हैं एक ही लाइन पर, /*!<, /**<, //!<, ///<।
• आप कक्षाओं, कार्यों, गुणों और चर में प्रलेखन जोड़ सकते हैं ।
• ये सभी आदेश गहरे हरे रंग के पाठ में दिखाई देते हैं, यह दर्शाता है कि वे मान्य कमांड हैं, सिवाय इसके @returns।
• अपने दस्तावेज़ों में नवीनतम परिवर्तन दिखाई देने से पहले आपको अपनी परियोजना (या Xcode को पुनः आरंभ) करने की आवश्यकता हो सकती है।

प्रलेखन देखने के लिए कहाँ:

1. कोड पूरा होने के दौरान, आप संक्षिप्त पाठ देखेंगे:

यह संक्षिप्त पाठ (बिना प्रारूपण के) दिखाएगा; यदि कोई संक्षिप्त पाठ मौजूद नहीं है, तो यह सभी पाठों के पहले @ब्लॉक तक एक संगोष्ठी दिखाएगा; यदि कोई भी मौजूद नहीं है (जैसे कि आप @return से शुरू करते हैं), तो यह सभी @ पट्टी से दूर सभी पाठ को समतल कर देगा।

2. पहचानकर्ता नाम का विकल्प-क्लिक करना:

3. क्विक हेल्प इंस्पेक्टर पैनल में

(पहले स्क्रीनशॉट देखें।)

4. Doxygen में

चूँकि Xcode 5 में कमांड Doxygen के साथ संगत हैं, आप डॉक्युमेंटेशन को डॉक्यूमेंटेशन फाइल बनाने के लिए डाउनलोड और इस्तेमाल कर सकते हैं।

अन्य नोट

Doxygen के सामान्य परिचय और ऑब्जेक्टिव-सी कोड को कैसे दस्तावेज़ित किया जाए, इसके लिए यह पृष्ठ एक अच्छे संसाधन की तरह लगता है।

समर्थित आदेशों में से कुछ का वर्णन:

• @brief: विवरण फ़ील्ड की शुरुआत में पाठ सम्मिलित करेगा, और एकमात्र पाठ है जो कोड पूरा होने के दौरान दिखाई देगा।

निम्नलिखित काम नहीं करते हैं:

• \n: एक नई रेखा उत्पन्न नहीं करता है। न्यूलाइन बनाने का एक तरीका यह सुनिश्चित करना है कि उस लाइन पर कुछ भी नहीं है। एक भी स्पेस कैरेक्टर नहीं!
• \example

निम्नलिखित समर्थित नहीं हैं (वे गहरे हरे रंग में भी दिखाई नहीं देते हैं):

• \ अदालत में तलब
• \ docbookonly
• \ enddocbookonly
• \ endinternal
• \ endrtfonly
• \ endsecreflist
• \ idlexcept
• \ mscfile
• \ refitem
• \ relatedalso
• \ rtfonly
• \ secreflist
• \कम
• \ टुकड़ा
• \विषय - सूची
• \ vhdlflow
• \ ~
• \ "
• ।
• ::
• \ |

Apple आरक्षित खोजशब्द:

Apple उन आरक्षित खोजशब्दों का उपयोग करता है जो केवल उनके प्रलेखन में काम आते हैं। यद्यपि वे गहरे हरे रंग में दिखाई देते हैं, ऐसा लगता है कि हम उनका उपयोग नहीं कर सकते जैसा कि Apple करता है। आप AVCaptureOutput.h जैसी फ़ाइलों में Apple के उपयोग के उदाहरण देख सकते हैं।

यहां उन कुछ कीवर्ड की एक सूची दी गई है:

• @abstract, @availibility, @class, @discussion, @deprecated, @method, @property, @protocol, @related, @ref।

सबसे अच्छा, कीवर्ड विवरण फ़ील्ड में एक नई लाइन का कारण होगा (उदाहरण @discussion)। सबसे खराब रूप से, कीवर्ड और इसका अनुसरण करने वाला कोई भी पाठ त्वरित सहायता (उदाहरण @class) में दिखाई नहीं देगा।

Comments

वर्णन के लिए धन्यवाद। उम्मीद है कि Apple इसे Xcode मैनुअल में कॉपी करेगा;)

— TheGrumpyCoda

साथ ही काम करता है @ प्रतीक @ का उपयोग करना।

— Drewsmits

+1 महान संग्रह! त्वरित सहायता में किसी अन्य वर्ग की त्वरित सहायता के लिए लिंक कैसे जोड़ें?

— सेल्विन

आप @cअगले शब्द को टाइपराइटर पाठ में प्रदर्शित करने के लिए भी उपयोग कर सकते हैं , जैसे कि Returns an @c NSString or @c nil.।

— मैथ्यू क्विरोस

क्या आपको विकल्प-क्लिक पॉपअप में URL प्राप्त करने का एक तरीका मिल गया है? उदाहरण के लिए, यदि आप विकल्प पर क्लिक करते हैं -[CADisplayLink addToRunLoop:forMode:], तो विवरण में अन्य वर्गों के नाम लिंक शामिल हैं (लेकिन मुझे लगता है कि वेब-फेसिंग URL उपयोगी होंगे)।

— ज़ेव ईसेनबर्ग

Answer 2

स्विफ्ट 2.0 निम्नलिखित सिंटैक्स का उपयोग करता है:

/**
        Squares a number.

        - parameter parameterName: number The number to square.

        - returns: The number squared.
    */

देखिए @paramअब कैसा है - parameter।

अब आप अपने दस्तावेज़ में बुलेट भी शामिल कर सकते हैं:

/**
        - square(5) = 25
        - square(10) = 100
    */

Answer 3

Senseful:

अपने दस्तावेज़ों में नवीनतम परिवर्तन दिखाई देने से पहले आपको अपनी परियोजना बनाने की आवश्यकता हो सकती है।

कभी-कभी यह मेरे लिए पर्याप्त नहीं होता है। Xcode को बंद करना और प्रोजेक्ट का बैक अप लेना आमतौर पर उन मामलों को ठीक करता है।

मुझे .h फ़ाइलों और .m फ़ाइलों में अलग-अलग परिणाम मिल रहे हैं। जब दस्तावेज़ टिप्पणियाँ किसी हेडर फ़ाइल में होती हैं तो मुझे नई लाइनें नहीं मिल सकती हैं।

Answer 4

अधिकांश स्वरूपण स्विफ्ट 2.0 के लिए बदल गया है (Xcode7 has3 के रूप में, format4 में भी सही है)

इसके बजाय :param: thing description of thing (जैसा कि स्विफ्ट 1.2 में था)

यह अभी है - parameter thing: description of thing

अधिकांश खोजशब्दों को - [keyword]: [description]इसके स्थान पर बदल दिया गया है :[keyword]: [description]। वर्तमान में कीवर्ड की सूची है कि काम भी शामिल नहीं है, abstract, discussion, brief, pre, post, sa,see , availability, class, deprecated, method, property, protocol, related, ref।