में जेनरेट किए गए कन्स्ट्रक्टर को कैसे दस्तावेज़ित करें हम अपने वर्गों को दस्तावेज करने के लिए डॉक्सिजन का उपयोग करते हैं। मैं स्पष्ट रूप से दस्तावेज करना चाहता हूं कि एक वर्ग ने रचनाकारों और/या विनाशकों को उत्पन्न किया है, यह इंगित करने के लिए कि मैंने इसके बारे में सोचा है और निर्णय लिया है कि उदा। जेनरेट की गई प्रतिलिपि का उपयोग कर प्रतिलिपि सुरक्षित है। हालांकि, कन्स्ट्रक्टर/विनाशक घोषित नहीं किया गया है और इसलिए डॉक्सिजन को यह नहीं पता कि दस्तावेज किस दस्तावेज से संबंधित है। क्या कार्य को कभी भी घोषित नहीं किया गया है, भले ही डॉक्सिजन में फ़ंक्शन टिप्पणियां शामिल हों?डॉक्सिजन
//! The Foo class documentation
class Foo {
//! @fn Foo(const Foo&)
//! Generated copy constructor OK to use
//! method documentation
void method();
}
इसके अलावा मैं जेनरेट की गई फ़ाइलों के हस्ताक्षर को भी लिखना नहीं चाहता।
मुझे लगता है कि मेरा दूसरा विकल्प क्लास हेडर में इसका वर्णन करना है। क्या कोई अन्य दृष्टिकोण है?
क्या आप वास्तव में प्रतिलिपि बनाने वाले निर्माता को दस्तावेज करने का कोई कारण देखते हैं? मेरा मतलब है कि यह स्पष्ट है कि यह क्या करता है, और यदि आप जेनरेट किए गए कन्स्ट्रक्टर के उपयोग की इजाजत दे रहे हैं, तो आप लेखक के रूप में स्पष्ट रूप से ठीक हैं। –
डॉक्सिजन जैसे टूल्स * उपयोगी * दस्तावेज़ीकरण के उत्पादन में असमर्थ क्यों हैं इसका अच्छा उदाहरण। बस उपयोगकर्ता को बताएं कि कक्षा कॉपी करने योग्य है। – jalf