2011-11-08 7 views
5

मुझे आमतौर पर this जैसे कोड टिप्पणी में कई छोटे कोड लिखने की आवश्यकता है। क्या यह ऐप्पल के हेडरडॉक में उपयोग करना संभव है? चूंकि इस प्रकार का कोड नोटेशन आमतौर पर भारी उपयोग किया जाता है, इसलिए मेरा मानना ​​है कि HTML टैग को चिह्नित करने के बजाय ऐसा करने का एक सुविधाजनक तरीका है।हेडरडॉक में कोड स्निपेट को कैसे चिह्नित करें?

उत्तर

1

मैं @c का उपयोग करने के साथ समाप्त हुआ।

This is an example @c code-style text. 
4

अपने HeaderDoc के भीतर, आप इस स्वरूपण का उपयोग कर सकते हैं:

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

स्रोत: https://stackoverflow.com/a/19169271/1736056

+1

यह काम नहीं करता प्रतीत होता है: 'हेडरडॉक टिप्पणी में अज्ञात फ़ील्ड प्रकार @code।' – ctn

4

आप कोड उपयोग के एक ब्लॉक प्रारूप में तैयार करना: @code & @endcode टैग की तरह:

/** 
* @code 
* [myObj myMethod]; 
* @endcode 
*/ 

यदि आप एक शब्द को प्रारूपित करना चाहते हैं @c पर्याप्त है, जैसे:

/** 
* @c is enough 
*/ 
1

@code और @c Headerdoc 8.9 के रूप में काम करने के लिए नहीं है।

<pre>@textblock 
@/textblock</pre> 
+0

जिसके लिए सही उत्तर की तलाश है। यह आपका जवाब है। – mkeremkeskin

0

मैं Xcode 6.4/HeaderDoc 8.9 और न @code है और न ही @c काम पर हूँ: मैं का उपयोग कर समाप्त हो गया। <pre>code</pre> काम करता है लेकिन न्यूलाइन जोड़ता है।

मैं <tt>code</tt> (टेलीलेट टेक्स्ट) का उपयोग करके इनलाइन कोड स्निपेट का उत्पादन करने में सक्षम होने के समाप्त हो गया।

संबंधित मुद्दे