2010-03-27 11 views
8
वे (उल्लेख नहीं किया गया

जब मैं खुले स्रोत परियोजनाओं के स्रोत फ़ाइलें मैं अक्सरअजीब लग रही टिप्पणियों - C++

/*  
@brief ...... 
@usage..... 
@remarks.... 
@par.... 
*/ 

सवाल
1. क्या टिप्पणी में कुछ अजीब वाक्यांशों के पार चलो के माध्यम से पढ़ा जाता है जब मैं सी ++ सीख रहा था)
2. क्या उनके पास कोई दस्तावेज है (जहां)

+0

हालांकि, डॉक्सिजन टिप्पणियां वास्तव में/* और //// के बजाय/** या /// के साथ चिह्नित की जाती हैं – sellibitze

उत्तर

16

वे केवल टिप्पणियां हैं और इस तरह सी ++ में कोई विशेष अर्थ नहीं है। टिप्पणियों से डेटा निकालने के लिए वे शायद एक दस्तावेज जनरेटर (उदाहरण के लिए Doxygen) की अनुमति देने के लिए हैं।

7

वे स्वचालित प्रलेखन जनरेटर के कुछ स्वाद के लिए हैं। एक और कार्यक्रम कोड के माध्यम से चलता है जैसे आप वहां देखते हैं। @... कीवर्ड यह पहचानते हैं कि दस्तावेज़ीकरण कैसे निर्धारित किया जाना चाहिए, और वह प्रोग्राम सीधे HTML कोड से सुंदर HTML या मुद्रित दस्तावेज़ उत्पन्न करता है। दस्तावेज़ों को कोड के साथ अद्यतित रखने के लिए यह एक तरीका है।

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