टिप्पणी करने के लिए और अधिक व्यावहारिक है, घोषणा (हेडर फ़ाइल में) या परिभाषा (स्रोत फ़ाइल में)? हो सकता है कि मुझे दोनों पर टिप्पणी करनी चाहिए, या न तो टिप्पणी करनी चाहिए और इसे सभी को एक अलग फाइल में डाल देना चाहिए ...क्या मुझे सी ++ में घोषणा या परिभाषा पर टिप्पणी करनी चाहिए?
आपको शीर्षलेख फ़ाइल को सर्वोच्च प्राथमिकता के साथ पूरी तरह से दस्तावेज करना चाहिए।
परिभाषा में टिप्पणियां कार्यान्वयन विवरण पर केंद्रित होनी चाहिए, जबकि शीर्षलेख टिप्पणियों को इंटरफेस पर केंद्रित किया जाना चाहिए।
जैसा कि आपने सुझाव दिया है, दस्तावेज़ीकरण का एक तीसरा स्रोत भी उपयोगी है। यह समग्र अवधारणा का वर्णन करना चाहिए।
हेडर फाइलों की टिप्पणी करने का एक बड़ा प्लस यह है कि यदि आप कुछ सरल वाक्यविन्यास का पालन करते हैं तो आप स्वचालित रूप से दस्तावेज़ बना सकते हैं। doxygen पर हैलो कहो!
टिप्पणी पर क्या निर्भर करता है, और आप इसे पढ़ने की उम्मीद किस पर निर्भर करते हैं।
मैं ypnos के जवाब में जोड़ना चाहते हैं:
कहाँ अपनी टिप्पणी जाना अपने दर्शकों है जो पर निर्भर करता है। बंद-स्रोत होने के नाते आपके कोड के बारे में सोचने से इस संबंध में मदद मिलती है: रखरखाव को कार्यान्वयन देखने को मिलता है, ग्राहक/उपयोगकर्ता केवल इंटरफ़ेस को देखते हैं। यदि उपयोगकर्ताओं के लिए टिप्पणी जरूरी है, तो इसे इंटरफेस में जाना होगा। यदि टिप्पणी केवल दिए गए कार्यान्वयन के लिए प्रासंगिक है, तो शायद इसे केवल कार्यान्वयन में जाना होगा (लेकिन जरूरी नहीं, आपके दर्शकों के आधार पर)।
मैं नहीं कह रहा हूं कि चयनित उत्तर गलत है (मैं इसके साथ सहमत हूं), लेकिन मुझे नहीं पता कि कोई इसे पूछने के चार मिनट बाद गैर-अनुभवजन्य उत्तर कैसे स्वीकार कर सकता है। –
जब मैंने इसे पढ़ा तो मुझे समझ में आया ... क्या यह इस साइट का मुद्दा नहीं है? यदि यह नहीं था, तो पूछताछ उत्तर चुनने में सक्षम नहीं होगा। –
निश्चित रूप से, लेकिन 4 मिनट के बाद आप कैसे जानते हैं कि एक बेहतर या अधिक अंतर्दृष्टिपूर्ण उत्तर प्रकट नहीं होगा। मैंने अभी यह अजीब पाया, बस इतना ही है। –