सी ++ में सार्वजनिक शीर्षलेख फ़ाइलों को बनाते समय आपको सबसे अच्छा अभ्यास क्या लगता है?सी/सी ++ हैडर फ़ाइल प्रलेखन
क्या शीर्षलेख फ़ाइलों में कोई, संक्षिप्त या बड़े पैमाने पर दस्तावेज़ नहीं होना चाहिए? मैंने लगभग सभी दस्तावेज (कुछ बाहरी दस्तावेजों पर निर्भर) से सब कुछ देखा है इनवेरिएंट्स, वैध पैरामीटर, रिटर्न वैल्यू इत्यादि के बड़े विनिर्देशों के लिए। मुझे यकीन नहीं है कि मैं वास्तव में क्या पसंद करता हूं, बड़े दस्तावेज अच्छे हैं क्योंकि आप हमेशा तक पहुंच सकते हैं यह आपके संपादक से है, दूसरी तरफ बहुत ही कम दस्तावेज़ीकरण वाले हेडर फ़ाइल अक्सर कक्षा के एक या दो पृष्ठों पर एक पूर्ण इंटरफ़ेस दिखा सकती है जो कक्षा के साथ क्या संभव है, इसका एक बेहतर अवलोकन प्रदान करती है।
मान लें कि मैं संक्षिप्त या बड़े पैमाने पर दस्तावेज जैसे कुछ के साथ जाता हूं। मुझे javadoc जैसा कुछ चाहिए जहां मैं वापसी मान, पैरामीटर इत्यादि दस्तावेज करता हूं। सी ++ में इसके लिए सबसे अच्छा सम्मेलन क्या है? जहां तक मुझे याद है कि डॉक्सिजन जावा डॉक-स्टाइल प्रलेखन के साथ अच्छी चीजें करता है, लेकिन क्या इसके लिए कोई अन्य सम्मेलन और उपकरण हैं, मुझे जवाडोक शैली दस्तावेज के लिए जाने से पहले अवगत होना चाहिए?