में ध्यान, ध्यान दें, टिप्पणी, कार्य करने की और चेतावनी के बीच चुनना Doxygen ध्यान, टिप्पणी, टिप्पणी, या कार्य करने की चेतावनी के रूप में टिप्पणी के एक टुकड़े को चिह्नित करने के लिए अनुमति देता है।प्रलेखन जनरेटर Doxygen
क्या दिशा निर्देशों मैं ठीक से उनमें से एक के रूप में एक टिप्पणी वर्गीकृत करने के लिए पालन करना चाहिए?
इन टैग के सभी विशेष रूप से उल्लेखनीय जा रहा है, अन्य वर्गों कि इतने में टैग नहीं की तुलना में के रूप में दस्तावेज़ीकरण का एक खंड पर प्रकाश डाला के प्रयोजन के लिए उपयोग किया जाता है। वे सभी टैग किए गए अनुच्छेद पर पाठक का ध्यान खींचने के लिए उपयोग किए जाते हैं।
नोट सबसे सामान्य टैग है, और अधिकांश मामलों में इसका उपयोग करने वाला एक है जहां आप पाठक को अनुभाग में वर्णित मामले का "नोटिस लेना" चाहते हैं।
ध्यान टैग एक विशेष रूप से महत्वपूर्ण ध्यान दें, एक है कि आप पाठक को नजरअंदाज नहीं करना चाहती उजागर करने के लिए इस्तेमाल किया जा सकता।
चेतावनी टैग ध्यान के बजाय इस्तेमाल किया जाना चाहिए जब वहाँ अगर पाठक वह कैसे उपयोग करता आइटम दर्ज किया गया में सावधान नहीं है नकारात्मक परिणामों पर विचार हो सकता है।
टिप्पणी और टिप्पणियां टैग नोटों कम महत्व है के लिए इस्तेमाल किया जा सकता है। यदि आप "ओह, वैसे" अर्थ में कुछ वर्णन करना चाहते हैं, तो इसके लिए टिप्पणी टैग उपयोगी है।
तोदो टैग दूसरों आप सूचीबद्ध की तुलना में अलग किया जाता है। आमतौर पर यह इंगित करने के लिए प्रयोग किया जाता है कि टिप्पणी में वर्णित कोड में एक या अधिक अधूरा पहलू हैं। यह कोड उपयोगकर्ता और कोड लेखकों दोनों को अलर्ट करता है कि कोड के प्रासंगिक खंड के बाद के संशोधन में एक सुविधा या बग को संबोधित करने की आवश्यकता है। डॉक्सिजन में एक अच्छी सुविधा है जहां यह सभी टोडोस को जेनरेट आउटपुट में अपने स्वयं के अनुभाग में सूचीबद्ध करेगा। इसे Doxyfile को संपादित करके और GENERATE_TODOLIST = YES से GENERATE_TODOLIST = NO को बदलकर बंद कर दिया जा सकता है।
तोदो टैग से संबंधित बग टैग, जो विशेष रूप इस्तेमाल किया जा सकता प्रलेखन एक सॉफ्टवेयर बग का वर्णन टैग करने के लिए है। इसी तरह, डॉक्सफाइल में GENERATE_BUGLIST = YES लाइन है जो सभी बग को अपने स्वयं के अनुभाग में सूचीबद्ध करने का कारण बनती है; इसे GENERATE_BUGLIST = NO के साथ बंद कर दिया जा सकता है।