36
मेरे पास एकाधिक फाइलों वाला एक सी प्रोग्राम है, इसलिए उदाहरण के लिए, stuff.c है जो फ़ंक्शन प्रोटोटाइप के साथ कुछ फ़ंक्शंस और stuff.h लागू करता है।सी में कार्यों को दस्तावेज करने के लिए कहां?
टिप्पणियों में कार्यों को दस्तावेज करने के बारे में मुझे कैसे जाना चाहिए?
क्या मेरे पास हेडर फ़ाइल में सभी दस्तावेज़ हैं, .c फ़ाइल में सभी दस्तावेज़, या दोनों के लिए दस्तावेज़ डुप्लिकेट करना चाहिए? मुझे बाद का दृष्टिकोण पसंद है, लेकिन फिर मैं उन समस्याओं में भाग लेता हूं जहां मैं उनमें से किसी एक पर दस्तावेज़ अपडेट करूँगा, न कि दूसरे (आमतौर पर वह जहां मैं पहला संशोधन करता हूं, यानी यदि मैं पहले हेडर फ़ाइल को संशोधित करता हूं, तो इसकी टिप्पणियां इसे प्रतिबिंबित करेगा, लेकिन अगर मैं कार्यान्वयन को अद्यतन करता हूं, तो केवल वे टिप्पणियां बदल जाएंगी)।
+1: अच्छी तरह से सारांशित। –