मुझे लगता है कि मैं जो पूछ रहा हूं वह यह है कि यह सुनिश्चित करने का सबसे अच्छा तरीका क्या होगा कि मेरा कोड पर्याप्त रूप से प्रलेखित है और दूसरे लोगों को उपयोग करने के लिए सही है?
खुले स्रोत के रूप में, सभी की सबसे महत्वपूर्ण टिप्पणियां कॉपीराइट और लाइसेंस अनुबंध टिप्पणी हैं। हर फ़ाइल की शुरुआत में एक बड़ी लंबी टिप्पणी के बजाय, आप एक छोटी और मीठी का उपयोग करना चाह सकते हैं जो संक्षेप में कॉपीराइट को निर्दिष्ट करता है और पाठक को रूट निर्देशिका में lic.txt को संदर्भित करता है।
मुझे पता है कि आपको हमेशा सब कुछ टिप्पणी करनी चाहिए और मैं हर विधि के लिए @ एप्स फीचर में डालने जा रहा हूं, लेकिन क्या सामान्य रूप से कोई अन्य सुझाव हैं?
सब कुछ टिप्पणी करें? नहीं। उस कोड को कमेंट करें जिसे सही मायने में कमेंट्री की आवश्यकता है। कमेंट करें। कोड के एक संभावित उपयोगकर्ता के रूप में, कक्षा परिभाषा के निम्नलिखित दो संस्करणों में से कौन सा आप देखना पसंद करेंगे?
संस्करण A:
class Foo {
private:
SomeType some_name; //!< State machine state
public:
...
/**
* Get the some_name data member.
* @return Value of the some_name data member.
*/
SomeType get_some_name () const { return some_name; }
...
};
संस्करण B:
/**
* A big long comment that describes the class. This class header comment is very
* important, but also is the most overlooked. The class is not self-documenting.
* Why is that class here? Your comments inside the class will say what individual parts
* do, but not what the class as a whole does. For a class, the whole is, or should be,
* greater than the parts. Do not forget to write this very important comment.
*/
class Foo {
private:
/**
* A big long comment that describes the variable. Just because the variable is
* private doesn't mean you don't have to describe it. You might have getters and
* setters for the variable, for example.
*/
SomeType some_name;
public:
...
// Getters and setters
...
// Getter for some_name. Note that there is no setter.
SomeType get_some_name () const { return some_name; }
...
};
वर्जन ए में मैंने क्लास को छोड़कर हर चीज का डॉक्यूमेंटेशन किया है। सामान्य रूप से एक वर्ग स्व-दस्तावेजीकरण नहीं है। संस्करण ए में मौजूद टिप्पणियां बिल्कुल बेकार हैं, या बेकार से भी बदतर हैं। "टिप्पणी सब कुछ" रवैये के साथ यह महत्वपूर्ण समस्या है। निजी डेटा सदस्य पर उस छोटी सी टिप्पणी में कुछ भी नहीं होता है, और गेट पर टिप्पणी करने वाले का नकारात्मक मूल्य होता है। गेटटर get_some_name()को वास्तव में एक टिप्पणी की आवश्यकता नहीं है। यह क्या करता है और क्या रिटर्न देता है यह कोड से स्पष्ट रूप से स्पष्ट है। कि कोई सेटर नहीं है - आपको इसका पता लगाना होगा क्योंकि यह वहां नहीं है।
संस्करण B में मैंने वह दस्तावेज दिया है जिसमें टिप्पणी करने की आवश्यकता है। गेट करने वाले के पास डॉक्सीजन टिप्पणी नहीं है, लेकिन इसमें टिप्पणी है कि कोई सेटर नहीं है।
अपनी टिप्पणियों की गिनती करें, और यह सुनिश्चित करें कि बार-बार कोड में बदलाव को प्रतिबिंबित करने के लिए टिप्पणियों की टिप्पणियों को बनाए नहीं रखा जाता है।