Doxygen कोड उदाहरणों में बहु-पंक्ति टिप्पणी कैसे सम्मिलित करें

Question

मैं एक कोड उदाहरण शामिल करने की कोशिश कर रहा हूं जिसमें डॉक्सिजन दस्तावेज़ में बहु-पंक्ति टिप्पणी शामिल है। समस्या यह है कि सी ++ प्रीप्रोसेसर 0xको मेरी डॉक्सीजन टिप्पणी के अंत के रूप में व्याख्या करता है और इसलिए फ़ाइल का सिंटैक्स टूटा हुआ है। इस तरह HTML निकाय का उपयोग कर स्लेश सांकेतिक शब्दों में बदलना:

/*! \brief My Doxygen comment. 
* 
* \code 
* myFunction() /* Some multi-line comment */ 
* \endcode 
*/ 

मैं पहले से ही सुझाव जो JavaDoc टिप्पणी के लिए काम करता है की कोशिश की:

उदाहरण के लिए

* \code 
* myFunction() /* Some multi-line comment */ 
* \endcode 

लेकिन यह काम नहीं करता (मुझे लगता है कि क्योंकि डॉक्सिजन कोड खंडों के भीतर HTML इकाइयों को प्रतिस्थापित नहीं करता है)।

तो सवाल यह है: क्या कोड उदाहरण में बहु-पंक्ति टिप्पणियां शामिल करना संभव है और यह कैसे किया जा सकता है?

Answer 1

विभिन्न टिप्पणी शैलियों का उपयोग करें।

इसके बजाय तुम्हारे पास क्या है की

, उपयोग:

/// \brief My Doxygen comment. 
/// 
/// \code 
/// myFunction() /* Some multi-line comment */ 
/// \endcode 
/// 

////*! रूप में ही है और एक Doxygen भाग चिह्नित करता है। प्री-प्रोसेसर प्रत्येक पंक्ति को एक पंक्ति टिप्पणी के रूप में मानेंगे।